CA1707: Los identificadores no deben contener caracteres de subrayado

  • Artículo
Propiedad Value
Identificador de la regla CA1707
Título Los identificadores no deben contener caracteres de subrayado
Categoría Nomenclatura
La corrección es problemática o no problemática Problemática: cuando se produce en ensamblados.

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

Causa

El nombre de un identificador contiene el carácter de subrayado (_).

Descripción de la regla

Por convención, los nombres del identificador no contienen el carácter de subrayado (_). La regla comprueba espacios de nombres, tipos, miembros y parámetros.

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.

Cómo corregir infracciones

Quite todos los caracteres de subrayado del nombre.

Cuándo suprimir las advertencias

No suprima las advertencias en el código de producción. Sin embargo, es seguro suprimirla en el código de prueba.

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 CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707

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.CA1707.severity = none

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Se debe suprimir la regla para los métodos conocidos del código de Microsoft que actualmente usan un carácter de subrayado y no se pueden modificar.

Configuración del código para analizar

Use la opción siguiente para configurar en qué partes del código base ejecutar esta regla.

Puede configurar esta opción 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