CA1715: Los identificadores deben tener el prefijo correcto

  • Artículo
Propiedad Value
Identificador de la regla CA1715
Título Los identificadores deben tener el prefijo correcto
Categoría Nomenclatura
La corrección es problemática o no problemática Problemática: cuando se desencadena en interfaces.

No problemática: cuando se produce en parámetros de tipo genérico.
Habilitado de forma predeterminada en .NET 8 No

Causa

El nombre de una interfaz no empieza por "I" mayúscula.

O bien

El nombre de un parámetro de tipo genérico en un tipo o método no empieza por "T" mayúscula.

De forma predeterminada, esta regla solo examina los métodos, los tipos y las interfaces visibles externamente, pero esto es configurable.

Descripción de la regla

Por convención, los nombres de ciertos elementos de programación comienzan con un prefijo específico.

Los nombres de interfaces deben empezar con una "I" mayúscula seguida de otra letra mayúscula. Esta regla notifica infracciones de nombres de interfaces, como "MyInterface" e "IsolatedInterface".

Los nombres de parámetros de tipo genérico deben empezar con una "T" mayúscula y, opcionalmente, pueden ir seguidos de otra letra mayúscula. Esta regla notifica infracciones de nombres de parámetros de tipo genérico, como "V" y "Tipo".

Las convenciones de nomenclatura proporcionan una apariencia común para las bibliotecas destinadas a Common Language Runtime. Esto reduce la curva de aprendizaje necesaria para las nuevas bibliotecas de software y aumenta la confianza del cliente respecto a que la biblioteca se haya desarrollado por parte de un especialista en desarrollo de código administrado.

Configuración del código para analizar

Use las opciones siguientes para configurar en qué partes del código base se va a ejecutar esta regla.

Puede configurar estas opciones solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Nomenclatura) a las que se aplica. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Parámetros de tipo de un solo carácter

Puede configurar si se deben excluir o no de esta regla los parámetros de tipo de un solo carácter. Por ejemplo, para especificar que esta regla no debe analizar los parámetros de tipo de un solo carácter, agregue uno de los siguientes pares clave-valor a un archivo .editorconfig en el proyecto:

# Package version 2.9.0 and later
dotnet_code_quality.CA1715.exclude_single_letter_type_parameters = true

# Package version 2.6.3 and earlier
dotnet_code_quality.CA2007.allow_single_letter_type_parameters = true

Nota

Esta regla nunca se desencadena para un parámetro de tipo denominado "T"; por ejemplo, Collection<T>.

Cómo corregir infracciones

Cambie el nombre del identificador para que tenga el prefijo correcto.

Cuándo suprimir las advertencias

No suprima las advertencias de esta regla.

Ejemplo de nombres de interfaces

En el fragmento de código siguiente se muestra una interfaz con el nombre incorrecto:

' Violates this rule
Public Interface Book

    ReadOnly Property Title() As String

    Sub Read()

End Interface

// Violation.
public interface Book
{
    string Title
    {
        get;
    }

    void Read();
}

El siguiente fragmento de código corrige la infracción anterior al agregar a la interfaz el prefijo "I":

// Fixes the violation by prefixing the interface with 'I'.
public interface IBook
{
    string Title
    {
        get;
    }

    void Read();
}

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

    ReadOnly Property Title() As String

    Sub Read()

End Interface

Ejemplo de nomenclatura de parámetros de tipo

En el fragmento de código siguiente se muestra un parámetro de tipo genérico con un nombre incorrecto:

' Violates this rule
Public Class Collection(Of Item)

End Class

// Violation.
public class Collection<Item>
{
}

El siguiente fragmento de código corrige la infracción anterior al agregar al parámetro de tipo genérico el prefijo "T":

// Fixes the violation by prefixing the generic type parameter with 'T'.
public class Collection<TItem>
{
}

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

End Class