Share via

CA1700: No nombrar valores de enumeración como 'Reserved'

  • Artículo
Propiedad Value
Identificador de la regla CA1700
Título No nombrar valores de enumeración como 'Reserved'
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 miembro de enumeración contiene la palabra "reserved".

Descripción de la regla

Esta regla supone que un miembro de la enumeración con un nombre que contiene la palabra "reserved" no se utiliza actualmente pero hace de marcador de posición para que se pueda quitar o cambiar el nombre en una versión posterior. Quitar o cambiar el nombre de un miembro es un cambio importante. No debería esperar que los usuarios omitan un miembro simplemente porque su nombre contiene "reserved", ni puede confiar en que los usuarios lean o sigan la documentación. Además, dado que los miembros reservados aparecen en los exploradores de objetos y en los entornos de desarrollo integrado inteligentes, pueden generar confusión sobre qué miembros se están utilizando realmente.

En lugar de usar un miembro reservado, agregue un nuevo miembro a la enumeración en la versión futura. En la mayoría de los casos, agregar un nuevo miembro no supone un cambio importante, siempre y cuando esto no provoque la modificación de los valores de los miembros originales.

En un número limitado de casos, agregar un miembro sí que supone un cambio importante, incluso cuando los miembros originales conservan sus valores originales. Básicamente, el nuevo miembro no se puede devolver desde rutas de código que ya existen sin interrumpir a los llamadores que usan una instrucción switch (Select en Visual Basic) en el valor devuelto que abarca toda la lista de miembros y que produce una excepción en el caso predeterminado. Una cuestión menor es que el código del cliente podría no manipular el cambio de comportamiento de métodos de reflexión como System.Enum.IsDefined. En consecuencia, si el nuevo miembro debe devolverse desde métodos que ya existen o si se produce una incompatibilidad de aplicaciones conocida debido a un uso deficiente de la reflexión, la única solución sin interrupción es la siguiente:

  1. Agregue una nueva enumeración que contenga los miembros originales y nuevos.

  2. Marque la enumeración original con el atributo System.ObsoleteAttribute.

    Siga el mismo procedimiento para cualquier tipo o miembro visible externamente que exponga la enumeración original.

Cómo corregir infracciones

Para corregir una infracción de esta regla, quite o cambie el nombre del miembro.

Cuándo suprimir las advertencias

Es seguro suprimir una advertencia de esta regla para un miembro que se usa actualmente o para las bibliotecas que se han 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 CA1700
// The code that's violating the rule is on this line.
#pragma warning restore CA1700

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.CA1700.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

CA2217: No marcar enumeraciones con FlagsAttribute

CA1712: No utilizar prefijos en valores de enumeración con el nombre del tipo

CA1028: El almacenamiento de la enumeración debe ser de tipo Int32

CA1008: Las enumeraciones deben tener un valor igual a cero

CA1027: Marcar enumeraciones con FlagsAttribute