CA1725: Los nombres de parámetro deben coincidir con la declaración base
Propiedad | Value |
---|---|
Identificador de la regla | CA1725 |
Título | Los nombres de parámetro deben coincidir con la declaración base |
Categoría | Nomenclatura |
La corrección es problemática o no problemática | Problemático |
Habilitado de forma predeterminada en .NET 8 | No |
Causa
El nombre de un parámetro en una invalidación de método no coincide con el nombre del parámetro en la declaración base del método o con el nombre del parámetro en la declaración de la interfaz del método.
De forma predeterminada, esta regla solo examina los métodos visibles externamente, pero es configurable.
Descripción de la regla
El uso del mismo nombre para un parámetro en una jerarquía de reemplazo aumenta la utilidad de los reemplazos de método. Cuando el nombre de un parámetro en un método derivado es distinto del nombre de la declaración base, puede resultar difícil determinar si el método es un reemplazo del método base o una nueva sobrecarga del método.
Cómo corregir infracciones
Para corregir una infracción de esta regla, cambie el nombre del parámetro para que coincida con la declaración base. La corrección es un cambio importante para los métodos visibles de COM.
Cuándo suprimir las advertencias
No suprima advertencias de esta regla excepto en los métodos visibles de COM en bibliotecas que se hayan enviado previamente.
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 CA1725
// The code that's violating the rule is on this line.
#pragma warning restore CA1725
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.CA1725.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 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