CA1700: Não nomear os valores de enum 'Reservado'

Artigo
08/08/2011

TypeName	DoNotNameEnumValuesReserved
CheckId	CA1700
<strong>Categoria</strong>	Microsoft.Naming
Alteração significativa	Quebrando

Causa

O nome de um membro de enumeração contém a palavra "reservada".

Descrição da regra

Esta regra pressupõe que um membro de enumeração tem um nome que contenha "reservado" não é usado no momento, mas é um espaço reservado para ser renomeado ou removido em uma versão futura. Renomear ou remover um membro é uma alteração significativa. Você não deve esperar os usuários para ignorar um membro, porque seu nome contém "reservados", nem você pode confiar em que os usuários leiam ou obedeçam a documentação. Além disso, como membros reservados aparecem em navegadores de objeto e de ambientes de desenvolvimento integrado inteligentes, eles podem causar confusão sobre quais membros estiverem sendo realmente utilizados.

Em vez de usar o membro reservado, adicione um novo membro à enumeração na versão futura. Na maioria dos casos a adição do novo membro não é uma alteração significativa, como a adição não faz com que os valores dos membros para alterar originais.

Em um número limitado de casos a adição de um membro é uma alteração significativa, mesmo quando os membros originais mantêm seus valores originais. Basicamente, o novo membro não pode ser retornado de caminhos de código existente sem quebrar os chamadores que usam um switch (Select na Visual Basic) a instrução no valor de retorno que abrange a lista de membros de todo e que lançam uma exceção no caso padrão. Uma preocupação secundária é que o código de cliente pode não lidar com a alteração no comportamento dos métodos de reflexão como Enum.IsDefined. Da mesma forma, se o novo membro deve ser retornado de métodos existentes ou incompatibilidade de um aplicativo conhecido ocorre devido ao uso da reflexão ruim, a única solução não-separável é: