Nomenclature Rules Review Options

Top  Previous  Next

 VS 

The Nomenclature Rules Review sub-section of the Quality Review section of the Team Options tab allows you create the nomenclature rules to be checked when the Review Quality feature is executed with this review selected:

NomenclatureRulesReview

The nomenclature rules can use control tags and type tags that are defined in the Control Tags Options and Type Tags Options.

To create a new nomenclature rule you use the following window:

NomenclatureRule

In this window you enter the following properties:

  • Id (optional): an identifier for the nomenclature rule.
     
  • Description: a brief text describing what the nomenclature rule checks.
     
  • Item to review: the item whose name is going to be reviewed. It can be any item, project, file, form, any control, any code element, class, field, etc.
     
  • What to review: you can review the name of an item in several ways.
     
    - The name must use a convention of prefixes, suffixes and a specific case (Pascal, Camel, all upper case, all lower case). For example, you can define a rule to check that control names start with a custom control tag.
     
    - The name must meet a condition with an operator and a value or a set of values. For example, you can define a rule to check that interface names start with "I". The condition is defined using a Condition editor.
     
    - The name length must meet a condition with an operator and a numeric value. For example, you can define a rule to check that variables have more than one letter, to avoid names like i or j. The condition is defined using a Condition editor.
     
  • When to review (optional): you can define conditions (using a When condition editor) for the review to be executed. You can set that all, any or none of the conditions must be met.
     
  • Explanation: the explanation tab has the Explanation field to describe in great detail what the review does and the How to fix field to explain the developer how to rename the item to meet the review.

See Also:

Review Quality

Quality Review Options

Condition Editor

When Condition Editor