CA1034: Các loại lồng nhau không được hiển thị

Question

Here's giải thích quy tắc mà tôi đang cố gắng hiểu. Dưới đây là mã được đơn giản hóa mà Trình phân tích mã đã phàn nàn về:

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 

Nếu enum chỉ liên quan đến lớp học, tại sao điều xấu là làm cho nó trở thành loại chứa trong lớp? Có vẻ gọn gàng với tôi ...

Có ai biết những gì có nghĩa là dòng sau ?:

loại lồng nhau bao gồm các khái niệm về khả năng tiếp cận thành viên, trong đó một số lập trình viên không hiểu rõ

Sử dụng Không gian tên để nhóm lớp và Enum không có vẻ giống như một cách hữu ích để giải quyết cảnh báo này, vì tôi muốn cả hai enum thuộc về cùng cấp cha mẹ như tên lớp.

Answer 1

Ngoài các vấn đề về tính khả dụng và khả năng phát hiện đã được đề cập trong các phản hồi khác, cũng có vấn đề về khả năng bảo trì tiềm năng. Điều gì xảy ra vào ngày bạn khám phá ra rằng enum của bạn cũng có khả năng hữu ích ở nơi khác? Di chuyển nó ra khỏi lớp cha mẹ của nó sẽ là một thay đổi phá vỡ, sao chép nó sẽ giới thiệu các vấn đề bảo trì riêng của mình, và yêu cầu người tiêu dùng API sử dụng nó với lớp khác bắt đầu trở nên xấu xí. Tại sao không tránh những vấn đề tiềm ẩn này bằng cách tránh các enums lồng nhau một cách hệ thống?

Answer 2

Tôi đoán nó chỉ ra rằng loại lồng nhau có thể bị nhầm lẫn với biến tĩnh bởi vì cả hai đều sẽ xuất hiện trong intellisense (tự động hoàn thành) sau ".".

Thậm chí nếu bạn nhìn thấy BCL (Thư viện lớp cơ sở) của .NET, tất cả các enums, ngay cả khi chúng chỉ được sử dụng trong một lớp, chúng không được lồng nhau, lý do là, khi bạn muốn so sánh hoặc khởi tạo, lớp tên + "." + tên enum sẽ gây nhầm lẫn như hình dưới đây, còn Microsoft là đúng là nó sẽ gây nhầm lẫn cho mọi người.

- Ví dụ

class RootClass 
{ 
    enum NestedEnum 
    { 
     StaticItem = 0  
    } 

    static string NestedString = ""; 
} 


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

Một là một loại và khác có thể thay đổi, hầu hết các cảnh báo MS Mã Analyzer là dành cho thiết kế tốt hơn, tuy nhiên nó có một ngoại lệ lớn cho @George, nếu bạn không thích nó, không sử dụng nó, chỉ cần đi trước và vô hiệu hóa các cảnh báo. Bạn chắc chắn có thể sử dụng tên lớp lớn thay vì không gian tên, nó chỉ đơn giản là sự lựa chọn của bạn. Nhưng kỹ năng lập trình tốt là về cách người khác tránh được mã của bạn chứ không phải những gì bạn thích !!!

Và không gian tên ở đó để tổ chức và tổ chức chúng tôi nhập ít hơn, đó là tất cả những gì để làm nhiều việc hơn với ít nỗ lực hơn. Nhưng nếu bạn thích những tên tuổi lớn, không ai ngăn bạn lại.

Answer 3

Enumerations thường không được đặt trong các lớp có sử dụng chúng, vì vậy mọi người không quen với việc xác định nơi liệt kê là:

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

Đặt liệt kê bên ngoài lớp học làm cho nó dễ dàng hơn để sử dụng:

Dim speed As New CustomerSpeed(ProfitTypeEnum.FlatAmount) 

Điều tra vẫn được chứa trong cùng một không gian tên như lớp. Khi giải thích phân tích chỉ ra, bạn nên sử dụng không gian tên để nhóm thành viên công khai thay vì lồng chúng vào nhau.