ReSharper Web Help

ReSharper lets you define naming rules for different symbols including but not limited to types, namespaces, interfaces, parameters, method properties and events, static fields, instance fields etc.

When you have a naming rule in force, ReSharper:

  • Keeps your specific naming guidelines in mind when it provides code completion options, generates new members, and expands templates.
  • Displays warnings when it detects members that don't comply with your naming style (in C# code):

For every kind of symbol, you can configure casing options, prefixes and suffixes, variations for different access rights, abbreviations to preserve, and other options.

Regarding language coverage, you can configure:

 Note

Most procedures below assume that the user configures common naming style. Steps for configuring language-specific naming styles are exactly the same.
To configure a naming style for predefined entities
  1. Choose ReSharper | Options | Languages | Common | Naming Style.
    Naming Style

     Tip

    You can start configuring naming rules right from the text editor where ReSharper detects an incorrectly named symbol. When ReSharper displays a warning or suggestion to rename a symbol, press Alt+Enter and choose Change settings for rule... from the list of quick-fixes. When the Edit Rule Settings dialog box for the corresponding entity opens, proceed with step 4.
  2. In the Naming Style tab, select one of predefined entities.
  3. Click Edit Coding_Assistance__Naming_Style__options__Edit_button.png. The Edit Rule Settings dialog box displays:
    Edit Rule Settings
  4. Configure name prefix, name suffix and naming style for the rule selected in the list at the top of the dialog box.
  5. Optionally, create additional rules for the selected code entity by clicking Add Coding_Assistance__Naming_Style__options__Add_button.png and configuring prefix, suffix and naming style for the new rule.

     Note

    When there are several rules for a single entity, one of them acts as the default rule (highlighted with bold). ReSharper doesn't display naming suggestions if a symbol matches at least one of configured rules. However, if a symbol doesn't match any rules, ReSharper suggests renaming it in accordance with the default rule.
  6. Optionally, reorder the sequence of rules by clicking Move Up Move_Up or Move Down Move_Down.
  7. Optionally, remove unnecessary rule by clicking Remove Remove.
  8. Clear the Enable inspections check box to prevent ReSharper from inspecting the selected code entity for naming style compliance. This setting applies to all naming rules for the current entity.
  9. Click OK to close the Edit Rule Settings dialog box.
  10. Click OK to close the ReSharper Options dialog box.
To create a user-defined naming rule
  1. Choose ReSharper | Options | Languages | Common | Naming Style.
  2. In the Naming Style tab, click Advanced settings. The Advanced Naming Settings dialog box displays:
    Advanced Settings
  3. Click Add Coding_Assistance__Naming_Style__options__Add_button.png to create a custom naming rule. The Edit Extended Naming Rule dialog box displays:
    Edit Extended Naming Rule
  4. In the Rule Description text box, specify a name for the new extended rule.
  5. In the Affected entitites area, select code entitites that the extended rule should cover.
  6. Use Access rights and Static/non-static areas to further constrain the scope of the extended rule.
  7. In the Naming style tab, configure one or more rules according to steps 4-6 of the procedure above: To configure a naming style for predefined entities.
  8. Click OK to close the Edit Extended Naming Rule dialog box.
  9. Click OK to close the ReSharper Options dialog box.
To create a list of abbreviations
  1. Choose ReSharper | Options | Languages | Common | Naming Style.
  2. In the Naming Style tab, click Advanced settings. The Advanced Naming Settings dialog box displays:
    Advanced Settings
  3. Add abbreviations that ReSharper should not warn you about in Edit abbreviations as plain text (UPPER CASE only) area. Use returns, commas, semicolons or spaces as delimiters.
  4. Click OK to close the Advanced Naming Settings dialog box.
  5. Click OK to close the ReSharper Options dialog box.

 Tip

You can also add abbreviations to the list from the text editor. When ReSharper detects a symbol name that contains an abbreviation which is not in the list, click Alt+Enter and select Add... to the abbreviations list:
Coding_Assistance__Naming_Style__add_to_abbreviations.png
To override common naming style with a language-specific naming style
  1. Choose one of the following:
    • ReSharper | Options | Languages | C# | C# Naming Style
    • ReSharper | Options | Languages | Visual Basic .NET | VB Naming Style
  2. Click Override common settings at the top of the selected tab.
  3. Configure a language-specific naming style as shown in procedures To configure a naming style for predefined entities and To create a user-defined naming rule above.

See Also

Procedures

Reference