Enums trong C # nên có tập tin riêng của họ? [đóng cửa]

Tôi có một lớp sử dụng một bảng liệt kê, enum hiện đang ở trong tệp riêng của nó có vẻ lãng phí.

Ý kiến ​​chung về enums được đặt trong không gian tên của tệp mà chúng được sử dụng là gì? Hoặc enum nên thực sự sống trong tập tin cs của riêng mình?

Biên tập

Tôi nên đề cập rằng trong khi lớp trong câu hỏi sử dụng các liệt kê này, người gọi bên ngoài cũng vậy. Nói cách khác, một lớp khác có thể thiết lập các bảng liệt kê này. Vì vậy, họ không được sử dụng nội bộ cho lớp học, nếu không câu hỏi này sẽ là không có trí tuệ.

Tôi sẽ không nói "lãng phí" (một tập tin bổ sung có giá bao nhiêu?), Nhưng nó thường bất tiện. Thông thường có một lớp được kết hợp chặt chẽ nhất với enum và tôi đặt chúng vào cùng một tệp.

Đây thực sự chỉ là một vấn đề ưu tiên.

Tôi thích đặt mỗi phép liệt kê trong tệp riêng của mình (tương tự cho từng giao diện, lớp và cấu trúc, cho dù nhỏ như thế nào). Nó giúp họ dễ dàng tìm thấy hơn khi tôi đến từ một giải pháp khác hoặc nếu không thì không có tài liệu tham khảo về loại câu hỏi.

Đặt một loại duy nhất trong mỗi tệp cũng giúp dễ dàng xác định các thay đổi trong hệ thống kiểm soát nguồn mà không bị chênh lệch.

Đây hoàn toàn là một vấn đề về phong cách. Những gì tôi có xu hướng làm là có một tệp được gọi Enums.cstrong giải pháp trong đó các khai báo enum được thu thập.

Nhưng dù sao chúng thường được tìm thấy thông qua F12khóa.

Câu hỏi để tự hỏi mình là: có bất cứ điều gì về một kiểu liệt kê trong C # chỉ ra rằng tôi nên đối xử với nó khác với tất cả các loại khác mà tôi tạo ra không?

Nếu liệt kê là công khai, nó nên được đối xử như bất kỳ loại công khai nào khác. Nếu nó là riêng tư, khai báo nó là một thành viên lồng nhau của lớp bằng cách sử dụng nó. Không có lý do thuyết phục để đặt hai loại công khai trong cùng một tệp chỉ vì một loại là liệt kê. Thực tế rằng nó là một loại công cộng là tất cả những gì quan trọng; hương vị của loại không.

Một ưu điểm khác của việc đặt từng loại (lớp, struct, enum) trong tệp riêng của nó là kiểm soát nguồn. Bạn có thể dễ dàng có được toàn bộ lịch sử của loại.

Tôi đặt chủ yếu bên trong không gian tên và bên ngoài lớp để có thể dễ dàng truy cập các lớp khác trong không gian tên như bên dưới.

namespace UserManagement
{
    public enum UserStatus { Active, InActive }
    class User
    {
        ...
    }
}

Nói chung, tôi thích các enum của mình ở cùng một tệp với Class mà nó có thể sẽ là một thuộc tính nhất. Nếu ví dụ tôi có một lớp Taskthì enum TaskStatussẽ nằm trong cùng một tệp.

Tuy nhiên, nếu tôi có enum có tính chất chung chung hơn, thì tôi giữ chúng theo ngữ cảnh trong các tệp khác nhau.

Nó phụ thuộc vào những gì cần thiết truy cập.

Nếu enum chỉ được sử dụng bởi một lớp duy nhất, bạn có thể khai báo nó trong lớp đó vì bạn không cần sử dụng nó ở bất kỳ nơi nào khác.

Đối với các enum được sử dụng bởi nhiều lớp hoặc trong API công khai, thì tôi sẽ luôn giữ định nghĩa trong tệp riêng của mình trong không gian tên thích hợp. Cách đó dễ dàng hơn nhiều và chiến lược đi theo mô hình một đối tượng trên mỗi tệp, cũng rất tốt để sử dụng với các lớp và giao diện.

Tôi nghĩ rằng nó phụ thuộc vào phạm vi của enum. Ví dụ, nếu enum dành riêng cho một lớp, ví dụ được sử dụng để tránh kịch bản hằng số ma thuật, thì tôi sẽ nói hãy đặt nó trong cùng một tệp với lớp:

enum SearchType { Forward, Reverse }

Nếu enum là chung và có thể được sử dụng bởi một số lớp cho các kịch bản khác nhau, thì tôi sẽ có xu hướng sử dụng đặt nó trong tệp riêng của nó. Ví dụ, dưới đây có thể được sử dụng cho một số mục đích:

enum Result { Success, Error }

Tôi có xu hướng đặt enum vào tệp riêng của họ vì một lý do rất đơn giản: như với các lớp và cấu trúc, thật tuyệt khi biết chính xác nơi cần tìm nếu bạn muốn tìm định nghĩa của một loại: trong tệp cùng tên. (Để công bằng, trong VS bạn luôn có thể sử dụng "Chuyển đến Định nghĩa".)

Rõ ràng, nó có thể ra khỏi tầm tay. Một đồng nghiệp nơi tôi làm việc thậm chí tạo các tệp riêng cho đại biểu.

Một lợi thế của việc sử dụng một tệp riêng cho enum là bạn có thể xóa lớp gốc đã sử dụng enum và viết một lớp mới bằng enum.

Nếu enum độc lập với lớp gốc thì việc đặt nó vào một tệp riêng biệt sẽ giúp thay đổi trong tương lai dễ dàng hơn.

Nếu bạn đang sử dụng bổ trợ Trình duyệt tệp USysWare cho Visual Studio, bạn có thể nhanh chóng tìm thấy các tệp có tên cụ thể trong giải pháp của mình. Hãy tưởng tượng tìm kiếm một enum không có trong tệp riêng của nó mà thay vào đó được chôn trong một số tệp trong một giải pháp khổng lồ.

Đối với các giải pháp nhỏ, điều đó không thành vấn đề, nhưng đối với các giải pháp lớn, việc giữ các lớp và enum trong các tệp riêng của chúng trở nên quan trọng hơn. Bạn có thể nhanh chóng tìm thấy chúng, chỉnh sửa chúng, và nhiều hơn nữa. Tôi rất, rất khuyên bạn nên đặt enum của bạn trong tập tin riêng của mình.

Và như đã nói ... Làm thế nào lãng phí là một tập tin cuối cùng chỉ là một vài kb?

Rất đơn giản lợi thế rất lớn để tách tập tin. Khi bất kỳ đối tượng nào nằm trong tệp MyObjectName.cs của chính nó ... bạn có thể truy cập giải pháp thám hiểm và nhập MyObjectName.cs và được hiển thị chính xác 1 tệp. Bất cứ điều gì làm cho gỡ lỗi tốt hơn là tốt đẹp.

Một ưu điểm khác trên một ghi chú tương tự, nếu bạn tìm kiếm tất cả các tệp ( ctrl+ shft+ F) cho một tên, bạn có thể tìm thấy 20 tham chiếu đến tên trong cùng một tệp ... và tên được tìm thấy sẽ là một phần của các đối tượng khác nhau. Trong cửa sổ Tìm kết quả, tất cả những gì bạn có thể thấy là số dòng và tên tệp. Bạn sẽ phải mở tệp và cuộn để tìm ra đối tượng được tìm thấy trong đó.

Bất cứ điều gì làm cho việc gỡ lỗi dễ dàng hơn, tôi thích.

Nếu bạn có nhiều dự án trong một giải pháp. Sau đó tốt hơn tạo một dự án khác Utilities. Sau đó tạo một Thư mục \Enumerationsvà tạo một lồng nhau static class. Và sau đó chỉ định mỗi lớp tĩnh nơi bạn sẽ tạo enum tương ứng với tên của các dự án của bạn. Ví dụ: bạn có một dự án có tên là DatabaseReader và DatabaseUsers thì bạn có thể đặt tên cho lớp tĩnh như

public static class EnumUtility {
    #region --Database Readers Enum
    public static class EnumDBReader {
         public enum Actions { Create, Retrieve, Update, Delete}; 
    }
    #endregion

    #region --Database Users Enum
    public static class EnumDBUsers {
         public enum UserIdentity { user, admin }; 
    }
    #endregion

}

Sau đó, toàn bộ enum có thể được sử dụng trong toàn bộ giải pháp cho mỗi dự án sẽ được khai báo trên đó. Sử dụng # regionđể phân tách từng mối quan tâm. Bằng cách này, nó dễ dàng hơn để tìm kiếm bất kỳ enum

Tôi muốn có một tệp enum công khai có tên E chứa mỗi enum riêng biệt, sau đó bất kỳ enum nào cũng có thể được truy cập bằng E ... và chúng ở một nơi để quản lý.