Công ước về tên tệp của các lớp chung

Question

Tôi muốn có thể phân biệt giữa phiên bản chung và thường (không chung chung) của một lớp. Giống như .NET framework, với các phiên bản chung và không chung chung của một số giao diện và các lớp sưu tập của nó. (Queue, Queue(T))

Tôi thường theo quy ước của một lớp cho mỗi tệp (như trong Java). Có quy ước chung nào để đặt tên tệp có chứa một lớp chung duy nhất không? Tôi chủ yếu quan tâm đến Windows (đặc biệt là NTFS) nhưng có vẻ như một quy ước tốt sẽ là (ít nhất một chút) xách tay.

Answer 1

Tại Microsoft, họ sử dụng ClassNameOfT.cs

Answer 2

Làm thế nào về:

Type.cs 

và

TypeGeneric.cs 

Bất cứ khi nào tôi đã làm điều này trong quá khứ tôi đã luôn đặt cả hai loại trong một tập tin với các loại phi generic như tên tập tin. Tôi nghĩ rằng điều này làm cho mọi thứ khá rõ ràng như .NET không có quy ước/hạn chế về một loại cho mỗi tệp như Java. Nhưng nếu bạn phải sau đó tôi sẽ đề nghị một cái gì đó như tôi đã ở trên, và sử dụng một hậu tố sẽ làm cho các tập tin hiển thị cùng nhau trong bất kỳ danh sách theo thứ tự bảng chữ cái (Solution Explorer, Windows Explorer, vv).

Dưới đây là một ý tưởng:

Type`1.cs 

này sẽ cho phép bạn để thoát ra khỏi kiểu generic khác nhau bởi số lượng các tham số kiểu generic họ chấp nhận. Nó chỉ là một suy nghĩ mặc dù tôi vẫn nghĩ rằng nó sẽ đơn giản hơn để chỉ cần đặt tất cả các loại trong một tập tin.

Answer 3

Tôi có thể có hai thư mục trong dự án, giống như Gereric, NonGeneric hoặc một cái gì đó tương tự. Họ vẫn có thể ở trong cùng một không gian tên, và sau đó cả hai đều có cùng tên tệp. Chỉ là một ý tưởng ...

Answer 4

Tất cả các lớp Microsoft mới sử dụng Generics. Các Queue và ArrayList đã có trước khi generics xuất hiện. Generics là con đường phía trước.

Quy ước đối với tệp một lớp cho mỗi tệp là đặt tên tệp sau tên lớp (cho dù chung là không). Đối với MyClass, bạn sẽ có MyClas.cs. Đối với mỗi không gian tên mới, bạn sẽ cần phải tạo một thư mục mới. Đây là cách Visual Studio cũng hoạt động.

Answer 5

Tôi có thể đặt chúng vào các thư mục và sử dụng cơ chế không gian tên thay thế. Bạn có thể so sánh với System.Collections so với System.Collections.Generic. Mặt khác, nếu nó phổ biến hơn không phải là các lớp học sử dụng Generics, có lẽ nó là tốt hơn để chỉ ra những người không. Đó là nếu bạn thực sự muốn tách các lớp chung từ các lớp khác. Cá nhân tôi thường không bận tâm để làm điều đó, vì tôi không thực sự thấy một lợi ích thiết thực từ nó.

Answer 6

Từ phản hồi cho đến nay có vẻ như không có sự đồng thuận.

Sử dụng cùng một tên tệp trong một không gian tên phụ (và thư mục con) "Generics" (như System.Collecctions.Generics) là một tùy chọn. Nhưng không phải luôn luôn mong muốn tạo ra một không gian tên mới. Ví dụ, trong một không gian tên hiện có với các lớp không chung chung được duy trì để tương thích ngược, nhưng được đánh dấu bằng ObsoleteAttribute, có lẽ tốt hơn là giữ các phiên bản chung trong cùng một không gian tên.

Tôi nghĩ hậu tố là một cách hợp lý để đi. Tôi đã áp dụng một quy ước của việc sử dụng các thông số loại như một hậu tố (như vậy: MyClassT cho MyClass < T> hoặc MyDictionaryKV cho MyDictionary < K, V>

Answer 7

Chỉ.. thấy câu hỏi này sau khi tìm kiếm những gì ước người khác sử dụng cho tên tập tin lớp generic

Gần đây tôi đã sử dụng ClassName[T].cs tôi thực sự thích Công ước này, và tôi nghĩ đó là vượt trội so với những người khác vì những lý do sau đây:..

• Các thông số loại nhảy ra ngoài với bạn ít hơn so với thông số Microsoft (ví dụ: ClassNameOfT.cs).
• Nó cho phép bạn có nhiều tham số loại mà không cần quá nhiều nhầm lẫn: Dictionary[TKey, TValue].cs
• Nó không yêu cầu bạn phải tạo ra bất kỳ thư mục đặc biệt, hoặc có lớp học chung của bạn trong một không gian tên đặc biệt. Nếu bạn chỉ có một vài lớp chung chung, có một không gian tên đặc biệt dành riêng cho họ chỉ là không thực tế.

Tôi đã mượn quy ước này từ cú pháp chung của Boo, mặc dù được sửa đổi đôi chút (Boo sử dụng ClassName[of T]).

Một số nhà phát triển dường như có một nỗi ám ảnh về tên tệp có chứa bất kỳ thứ gì ngoài chữ cái và dấu gạch dưới, nhưng một khi bạn có thể vượt qua, quy ước này dường như hoạt động rất tốt.

Answer 8

Không sử dụng dấu huyền `trong tên tập tin chung chung của bạn nếu bạn đang chạy Visual Studio 2008. Có một vấn đề được biết đến với họ gây ra breakpoint để thất bại:

http://connect.microsoft.com/VisualStudio/feedback/details/343042/grave-accent-in-filename-causes-failure-to-recognize-target-language-breakpoints-fail

Answer 9

tôi thấy rằng chủ đề này đã bị hủy bỏ hơn một năm trước, nhưng tôi vẫn muốn chia sẻ quan điểm của tôi về quy ước này.

Trước hết, có nhiều lớp có cùng tên nhưng chỉ khác nhau về lượng tham số kiểu không phải lúc nào cũng là trường hợp tương thích ngược. Chắc chắn, bạn không nhìn thấy nó rất thường xuyên, nhưng các lớp Action- và Func mới của .NET đã được thiết kế theo cách này, và tôi hiện đang thực hiện một cái gì đó tương tự.

Để rõ ràng và distinguishability, tôi sử dụng quy ước sau mà chỉ xác định số lượng đối số chung cho một loại nhất định:

• MyClass.cs
• MyClass.T1.cs
• MyClass.T2 .cs

Bằng cách này, tên tệp của tôi vẫn ngắn gọn và đơn giản trong khi vẫn giao tiếp rõ ràng tên lớp và số lượng thông số loại khác với chi phí của dấu chấm đơn giản (đó là, theo kinh nghiệm của tôi, một điều được chấp nhận phổ biến để làm trong một tên tệp và trông đẹp hơn nhiều so với các ký tự không phải chữ cái và chữ số khác, nhưng đây chỉ là vấn đề về hương vị mà tôi đoán).Đặt tên (hoặc từ viết tắt) của các tham số kiểu chỉ kéo dài tên tập tin trong khi ở cấp độ này, tôi không thực sự quan tâm đến tên thật của các tham số kiểu ...

Answer 10

Cá nhân tôi sẽ không sử dụng dấu nghiêm trọng ký hiệu:

Foo.cs 
Foo`1.cs 

Vì lý do đơn giản là tôi sợ giọng nghiêm trọng. Nó không chỉ có một tên đáng sợ, nhưng tôi không chắc chắn nó sẽ được xử lý như thế nào bởi các hệ thống tập tin khác nhau, các hệ thống điều khiển phiên bản và trong các URL. Do đó, tôi muốn dính vào các ký tự chữ và số phổ biến.

NameOfT.cs dường như được sử dụng trong ASP.NET Core MVC theo tìm kiếm trên GitHub. 12 kết quả. Reference.

Cũng hạn chế sử dụng trong CoreFX. 3. Kết quả. Reference.

Ví dụ:

Foo.cs 
FooOfT.cs