Details

    • Type: Language-Specification
    • Status: Active
    • Resolution: Unresolved
    • Labels:
      None
    • Message:
      Rename this class to match the regular expression: "xxx".
    • List of parameters:
      Hide
      • key = format
      • description = Regular expression used to check the class names against.
      • default = ^([A-Z] {1,3}

        [a-z0-9]+)*([A-Z]

        {2}

        )?$

      • type = STRING
      Show
      key = format description = Regular expression used to check the class names against. default = ^( [A-Z] {1,3} [a-z0-9] +)*( [A-Z] {2} )?$ type = STRING
    • Impact:
      Unknown 'null' severity
    • Likelihood:
      Unknown 'null' severity

      Description

      Sharing some naming conventions is a key point to make it possible for a team to efficiently collaborate. This rule allows to check that all class names match a provided regular expression.

      The default configuration is the one recommended by Microsoft:

      • Pascal casing, starting with an upper case character, e.g. BackColor
      • Short abbreviations of 2 letters can be capitalized, e.g. GetID
      • Longer abbreviations need to be lower cased, e.g. GetHtml

      Noncompliant Code Example

      With the default regular expression {{^([A-Z]

      {1,3}

      [a-z0-9]+)*([A-Z]

      {2}

      )?$}}:

      Class foo ' Noncompliant
      End Class
      

      Compliant Solution

      Class Foo ' Compliant
      End Class
      

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              massimo.paladin Massimo PALADIN
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: