Naming Standards Manager
Applies to: Visual Studio .NET 2002, Visual Studio .NET 2003, Visual Studio 2005, Visual Studio 2008

The Naming Standards Manager will help you define standards for variable, control and function argument names.

To edit standard naming conventions:

1. In the CodeSMART main menu, select the Naming Standards Manager entry or click the synonymous button from the Managers and Review Tools toolbar (quick toolbar and menu references are available).
2. Click on the Prefixes and Suffixes/Default tree node to specify how type name information should be generated. By default the first three characters in the type short name will be used as a prefix, and the type short name in its entirety will be used as a suffix.
3. Click on the Prefixes and Suffixes/User Defined tree node to customize the default behavior for certain types.

   

   • Globally enable/disable customization by using the Enable the following... checkbox.
   • Add, modify or delete types that you want to use custom prefixes and suffixes by using the corresponding buttons. If adding or modifying, please note that you should use full names for each type.
   • When and excepted type is selected in the list, the table updates its contents to display its custom prefix and suffix for both Visual Basic and C#. You can change these directly in the table. If you want to disable a customization, uncheck the corresponding checkbox for the desired language.
4. Click on one of the Name Composition tree node children to configure how the corresponding item name should be built; the following example shows how to set up Variable Naming:
   

   

   
   
   • A type name information string should be included in the name: check this option if you want to include type information in generated variable names. This information can be added as a prefix or as a suffix generated by using the default or custom rules defined above.
   • All class member variables should have a scope string attached (code variables only): check this option if you want to distinguish class member variables from local ones by adding a scope prefix or suffix.
   • All global variables should have a scope string attached (code variables only): check this option if you want to mark global variables with a certain prefix or suffix.
   • Make sure the first letter of the variable/parameter name is lowercase (code variables and arguments only): check this option to make sure that the variable name - prefixed or not - always starts with a lowercase letter.
5. Press the OK button to make changes effective.

Back to top