CA1034: Los tipos anidados no deberían estar visibles

Question

Here's una explicación de la regla que estoy tratando de comprender. Aquí está el código simplificado que el analizador de código se quejaba:

Public Class CustomerSpeed 

    Public Enum ProfitTypeEnum As Integer 
     NotSpecified = 0 
     FlatAmount = 1 
     PercentOfProfit = 2 
    End Enum 

    Private _ProfitTypeEnum As ProfitTypeEnum 

    Public Sub New(ByVal profitType As ProfitTypeEnum) 

     _ProfitTypeEnum = profitType 

    End Sub 

End Class 

Si la enumeración se refiere sólo a la clase, ¿por qué es una mala cosa para que sea un tipo de contenido dentro de la clase? Parece más ordenado para mí ...

¿Alguien sabe lo que se quiere decir con la siguiente línea ?:

tipos anidados incluyen la noción de accesibilidad miembros, que algunos programadores no entienden claramente

Uso Los espacios de nombres para agrupar la clase y Enum no parecen una forma útil de resolver esta advertencia, ya que me gustaría que tanto la enumeración pertenezcan al mismo nivel padre como el nombre de la clase.

Answer 1

Además de los problemas de usabilidad y descubrimiento detectados en otras respuestas, también existe un problema potencial de mantenimiento. ¿Qué sucede el día en que descubres que tu enumeración también es potencialmente útil en otro lugar? Sacarlo de su clase principal sería un cambio radical, copiarlo introduciría sus propios problemas de mantenimiento y requeriría que los consumidores API lo usen con otra clase que se pone fea. ¿Por qué no evitar estos posibles problemas al evitar sistemáticamente enumeraciones anidadas?

Answer 2

Supongo que indica que el tipo anidado se puede confundir con la variable estática porque ambos aparecerán en intellisense (autocompletar) después del ".".

Incluso si ve BCL (Biblioteca de clases base) de .NET, todas las enumeraciones, incluso si solo se usan en una clase, no están anidadas, razón por la cual, cuando se quiere comparar o crear instancias, la clase nombres + "." + los nombres enum serán confusos como se muestra a continuación, también Microsoft tiene razón en que confundirá a las personas.

- Ejemplo

class RootClass 
{ 
    enum NestedEnum 
    { 
     StaticItem = 0  
    } 

    static string NestedString = ""; 
} 


RootClass.NestedEnum <-- represents enum, 
RootClass.NestedString <-- represents static variable 

Se trata de un tipo y otro es variable, la mayoría de las advertencias MS Código del analizador son para un mejor diseño, sin embargo, tiene una gran excepción de @George, si no te gusta, no te Úselo, solo siga adelante y deshabilite las advertencias. Ciertamente puede usar nombres de clase grande en lugar de espacios de nombres, es simplemente su elección. Pero una buena capacidad de programación se trata de cómo otros perciben tu código en lugar de lo que te gusta.

Y los espacios de nombres están ahí para organizar y, al organizar, escribimos menos, eso es todo acerca de hacer más trabajo con menos esfuerzo. Pero si te gustan los grandes nombres, nadie te detiene.

Answer 3

enumeraciones no se suelen colocar en la clase que los utiliza, por lo que las personas no están acostumbrados a que especifique, en la enumeración es:

Dim speed As New CustomerSpeed(CustomerSpeed.ProfitTypeEnum.FlatAmount) 

La colocación de la enumeración fuera de la clase hace que sea más fácil de usar:

Dim speed As New CustomerSpeed(ProfitTypeEnum.FlatAmount) 

La enumeración todavía está contenida en el mismo espacio de nombres que la clase. Como lo explica la explicación del análisis, debe usar espacios de nombres para agrupar miembros públicos en lugar de anidarlos entre sí.