CA1716: Los identificadores no deben coincidir con palabras clave
| Propiedad | Value |
|---|---|
| Identificador de la regla | CA1716 |
| Título | Los identificadores no deben coincidir con palabras clave |
| Categoría | Nomenclatura |
| La corrección es problemática o no problemática | Problemático |
| Habilitado de forma predeterminada en .NET 9 | No |
Causa
El nombre de un espacio de nombres, tipo o miembro virtual o de interfaz coincide con una palabra clave reservada en un lenguaje de programación.
De forma predeterminada, esta regla solo examina los espacios de nombres, tipos y miembros visibles externamente, pero puede configurar la visibilidad y los tipos de símbolos.
Descripción de la regla
Los identificadores de los espacios de nombres, tipos y miembros virtuales o de interfaz no deben coincidir con palabras clave definidas por los lenguajes que tienen como destino Common Language Runtime. Dependiendo del lenguaje y la palabra clave que se use, los errores del compilador y las ambigüedades pueden dificultar el uso de la biblioteca.
Esta regla comprueba las palabras clave en los lenguajes siguientes:
- Visual Basic
- C#
- C++/CLI
La comparación sin distinción entre mayúsculas y minúsculas se usa para palabras clave de Visual Basic, y la comparación con distinción entre mayúsculas y minúsculas se usa para los demás lenguajes.
Cómo corregir infracciones
Seleccione un nombre que no aparezca en la lista de palabras clave.
Cuándo suprimir las advertencias
Puede suprimir una advertencia de esta regla si está seguro de que el identificador no va a confundir a los usuarios de la API, y de que la biblioteca se puede usar en todos los lenguajes disponibles en .NET.
Supresión de una advertencia
Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.
#pragma warning disable CA1716
// The code that's violating the rule is on this line.
#pragma warning restore CA1716
Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.
[*.{cs,vb}]
dotnet_diagnostic.CA1716.severity = none
Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.
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 tan solo para esta regla, para todas las reglas a las que sean aplicables o para todas las reglas de esta categoría (Naming) para las que sean aplicables. 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 se ejecutará esta regla, en función de su accesibilidad, mediante la configuración de la opción api_surface. 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
Nota:
Reemplace la parte XXXX de CAXXXX por el identificador de la regla que sea de aplicación.
Tipos de símbolos analizados
Puede configurar los tipos de símbolos que se analizarán mediante esta regla. Entre los valores permitidos se incluyen los siguientes:
NamespaceNamedTypeMethodPropertyEventParameter
Separe los distintos valores con una coma (,). El valor predeterminado incluye todos los tipos de símbolos de la lista anterior.
dotnet_code_quality.CA1716.analyzed_symbol_kinds = Namespace, NamedType, Method, Property, Event
