Webel ‘$info$f$’ prefix convention for function help holder Strings

Gallery
Tutorial
[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.
Section
SECTION: Webel coding and naming conventions for the Wolfram Language
Topic level
ESSENTIAL
Mathematica keywords
String
Webel Mathematica keywords
'$info$f$'
Keywords
Click on the image to view it full size
For reference, the associated policy note (you don't need to visit it yet):
Webel: Mathematica: CONVENTION: A function's description (but not its signature, arguments, or options) may be captured as an '$info$f$' Stringhelp holder for use by the Doc` package for ::usage generation and the HelpF`& HelpO` help registry packages.
Up next
Webel ‘def$’ DRY default capture! Applicable to arguments and options.
Notes
[NAMING, OPTION, PATTERN, TIP]{OPTION} Mathematica: Webel: You CAN/MAY use $ in variable names and function names - just not as the first character before a Capital - and it's extremely useful. You won't get sent to Azkaban prison if do you use a $ character!
[CONVENTION, NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: A function's description (but not its signature, arguments, or options) may be captured as an '$info$f$' Stringhelp holder for use by the Doc` package for ::usage generation and the HelpF`& HelpO` help registry packages.
[CONVENTION, NAMING]{STRICT} Webel: Mathematica: CONVENTION: A prefix '$doc' indicates a documentation String for each primary variable/quantity (argument or output)
Snippets (quotes/extracts)
Visit also
The Webel SysML4Mathematica recipe for modelling Wolfram Language code in Systems Modeling Language (SysML) for Model-Based Systems Engineering
Visit also (backlinks)
Related slides (includes other tutorials)
DRY not WET! "Don't Repeat Yourself!"
Related slides (backlinks, includes other tutorials)
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
Why the Webel HelpF` & HelpO` registries?