The Webel $k$ prefix convention for Association String keys

Note that this policy does not state that Associations MUST use Strings as keys in all Associations, just that where Strings are indeed used they SHOULD be encapsulated as '$k$' String variables.

The '$k$' convention has standalone use, and it is also used in combination with other conventions. For examples, as we'll see in later slides, the Webel help Rule system used to register '$opt$' (options) and '$arg$' (arguments) help holders with the HelpF` and HelpO` help registries uses the '$k$' key convention.

Up next

The Webel ‘$pat$’ pattern helper convention for frequently used Patterns

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: Where keys of Associations are Strings they are encapsulated as variables prefixed with '$k$' (promotes DRY and has many advantages, such as IDE prompting). Direct use of "Strings" as keys is WET and strongly discouraged!

Snippets (quotes/extracts)

Visit also

The Webel SysML4Mathematica recipe for modelling Wolfram Language code in Systems Modeling Language (SysML) for Model-Based Systems Engineering