Naming Conventions

[JMichaelTX]

@DanThomas

The one convention I am adamant about is variable naming. I always prefix variable names with a short string of lower-case letters that correlate to the macro containing them. For instance, a macro called "Reveal Macro Group" will have variable names like "rmgGroupName", etc

I totally agree with Dan on using variable prefixes.
We have a minor difference on naming convention, which is pure style, pure preference.
I prefer a prefix of uppercase followed by two underscores.

So, Dan's example of "rmgGroupName" would be:
"RMG__GroupName"

The reasons I like this prefix naming convention are:

• Easier to spot in the KM Variable list
• When used in a "Prompt for User Input", the prefix is NOT shown, providing a more user-friendly display.

Choose whichever you prefer, or make up your own.

During development and testing of a macro, I do NOT delete the Variables used in the macro at the end of the macro.

• This allows me to use the KM Variable list for debugging.
• When I am finished, I add a block at the bottom of the macro to delete all Variables used (except for those that begin with "DND_".
• I use a script that deletes all variables with a given prefix.

I agree with everything else Dan said about naming conventions.
One thing I may add is:

• Do make good use of naming conventions
• Choose conventions that are intuitive for you, but also would make sense to others