Project NameCheck enforces naming standards. This and the following pages describe how to configure it to conform to your own naming conventions.
Scopes
Types, Controls and Modules
Special
Misc
Practical issues
Project NameCheck is all about enforcing the scope and type prefixes/suffixes for all names in your project—the way you want. It is especially useful for enforcing Hungarian style naming standards, but can also be configured to allow other standard types.
Start the configuration on the Misc page. When you have made enough changes, hit the Test button to try the settings on some examples. You might also want to try them against your projects every now and then to learn how the settings work.
First you need to specify what kind of things you wish to include in the standard. Your basic options are:
Check scope: Include scope checking in the standard.
Check type: Include data type checking in the standard.
If you check scope or type (but not both), you have 2 ways to build a name: with a prefix or with a suffix.
If you check scope and type, you have 6 ways to build a name: with a prefix, with a suffix or a mix.
Check type | Check scope | Order | Prefix | Suffix | Mixed prefix + suffix | |
---|---|---|---|---|---|---|
On | Off | Type + base | base + Type | |||
Off | On | Scope + base | base + Scope | |||
On | On | Scope first, type second | Scope + Type + base | base + Scope + Type | Scope + base + Type | Type + base + Scope |
Type first, scope second | Type + Scope + base | base + Type + Scope |
How do you determine if you should use prefixes, suffixes or a mix? It depends on the settings on the preceding pages, namely pages Scopes, Types, Controls, Modules and Special.
Scopes
Types, Controls and Modules
Special
Misc
Practical issues
The following names are not checked under any of the settings.
There are special names that you may not want to use according to your standards. Examples could be integers i and j. Add any such names to the Ignore page.
You can also exclude portions of code from Project NameCheck by using the '$PROBHIDE NAMECHECK comment directive.