CA1034: I tipi annidati non dovrebbero essere visibili

Question

Here's una spiegazione della regola che sto cercando di capire. Ecco il codice semplificato che il Codice Analyzer si lamentava:

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 

Se l'enumerazione riguarda solo la classe, perché è una brutta cosa per renderlo un tipo contenuto all'interno della classe? Sembra più ordinato a me ...

Qualcuno sa che cosa si intende con la seguente riga ?:

tipi nidificati includono la nozione di membro di accessibilità, che alcuni programmatori non capiscono chiaramente

Utilizzando I namespace per raggruppare Class ed Enum non sembrano un modo utile per risolvere questo avvertimento, dal momento che vorrei che l'enum appartenesse allo stesso livello genitore del nome della classe.

Answer 1

Oltre ai problemi di usabilità e rilevabilità già trattati in altre risposte, esiste anche un potenziale problema di manutenibilità. Cosa succede nel giorno in cui scopri che il tuo enum è potenzialmente utile anche altrove? Spostarlo fuori dalla sua classe genitore sarebbe un cambiamento irrisorio, copiarlo introdurrebbe i suoi problemi di manutenibilità, e richiedere ai consumatori API di usarlo con un'altra classe inizia a diventare brutto. Perché non evitare questi potenziali problemi evitando sistematicamente enumerazioni annidate?

Answer 2

Suppongo che indichi che il tipo annidato può essere confuso con la variabile statica perché entrambi appariranno in intellisense (completamento automatico) dopo ".".

Anche se si vede BCL (Base Class Library) di .NET, tutte le enumerazioni, anche se sono utilizzate solo in una classe, non sono nidificate, la ragione è, quando si desidera confrontare o creare un'istanza, la classe nomi + "." + i nomi enumerati saranno confusi come mostrato di seguito, anche Microsoft ha ragione che confonderà le persone.

- Esempio

class RootClass 
{ 
    enum NestedEnum 
    { 
     StaticItem = 0  
    } 

    static string NestedString = ""; 
} 


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

Uno è un tipo e l'altro è variabile, la maggior parte delle avvertenze MS Codice Analyzer sono per una migliore progettazione, però ha un grande eccezione per @George, se non vi piace, non lo usalo, vai avanti e disabilita gli avvertimenti. Puoi certamente usare grandi nomi di classi invece di spazi dei nomi, è semplicemente la tua scelta. Ma le buone capacità di programmazione riguardano il modo in cui gli altri considerano il tuo codice piuttosto che ciò che ti piace !!!

E gli spazi dei nomi sono lì per organizzare e con l'organizzazione scriviamo di meno, questo è tutto ciò che serve per fare più lavoro con meno sforzi. Ma se ti piacciono i grandi nomi, nessuno ti fermerà.

Answer 3

enumerazioni non sono in genere collocati nella classe che li utilizza, così la gente non sono abituati ad avere specificare dove l'enumerazione è:

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

Posizionando l'enumerazione di fuori della classe rende più facile da usare:

Dim speed As New CustomerSpeed(ProfitTypeEnum.FlatAmount) 

L'enumerazione è ancora contenuta nello stesso spazio dei nomi della classe. Come indica la spiegazione dell'analisi, dovresti utilizzare gli spazi dei nomi per raggruppare i membri pubblici piuttosto che annidarli l'uno nell'altro.