CA1715: Identifiers should have correct prefix

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

For the latest documentation on Visual Studio 2017, see CA1715: Identifiers should have correct prefix on docs.microsoft.com.

TypeNameIdentifiersShouldHaveCorrectPrefix
CheckIdCA1715
CategoryMicrosoft.Naming
Breaking ChangeBreaking - when fired on interfaces.

Non-breaking - when raised on generic type parameters.

The name of an externally visible interface does not start with an uppercase 'I'.

-or-

The name of a generic type parameter on an externally visible type or method does not start with an uppercase 'T'.

By convention, the names of certain programming elements start with a specific prefix.

Interface names should start with an uppercase 'I' followed by another uppercase letter. This rule reports violations for interface names such as 'MyInterface' and 'IsolatedInterface'.

Generic type parameter names should start with an uppercase 'T' and optionally may be followed by another uppercase letter. This rule reports violations for generic type parameter names such as 'V' and 'Type'.

Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.

Rename the identifier so that it is correctly prefixed.

Do not suppress a warning from this rule.

The following example shows an incorrectly named interface.

Imports System

Namespace Samples

    Public Interface Book      ' Violates this rule

        ReadOnly Property Title() As String

        Sub Read()

    End Interface

End Namespace

The following example fixes the previous violation by prefixing the interface with 'I'.

Imports System

Namespace Samples

    Public Interface IBook  ' Fixes the violation by prefixing the interface with 'I'

        ReadOnly Property Title() As String

        Sub Read()

    End Interface

End Namespace

The following example shows an incorrectly named generic type parameter.

Imports System

Namespace Samples

    Public Class Collection(Of Item)    ' Violates this rule

    End Class

End Namespace

The following example fixes the previous violation by prefixing the generic type parameter with 'T'.

Imports System

Namespace Samples

    Public Class Collection(Of TItem)  ' Fixes the violation by prefixing the generic type parameter with 'T'

    End Class

End Namespace

CA1722: Identifiers should not have incorrect prefix

Show: