từ viết tắt trong Camel Trở lại

Question

Tôi thường thấy tên lớp Java như

XmlReader 

thay vì

XMLReader 

cảm giác ruột của tôi là hoàn toàn chữ hoa từ viết tắt, nhưng dường như nhiều người nghĩ khác nhau. Hoặc có thể chỉ vì rất nhiều trình tạo mã đang gặp sự cố với từ viết tắt ...

Vì vậy, tôi muốn nghe ý kiến ​​của công chúng. Làm cách nào để viết hoa tên lớp có chứa từ viết tắt?

Answer 1

Chúng tôi sử dụng quy ước trường hợp lạc đà như Java và .NET. Không phải vì lý do của các trình tạo mã, nhưng để dễ đọc. Hãy xem xét trường hợp kết hợp hai từ viết tắt trong một tên, ví dụ một lớp chuyển đổi XML thành HTML.

XMLHTMLConverter 

hoặc

XmlHtmlConverter 

Mà một trong những bạn thích?

Answer 2

Tôi thấy rằng XMLReader khó đọc hơn. Lý do là bạn không thể dễ dàng biết nơi các từ được tách ra. Tôi tin rằng các từ viết tắt có chữ thường phải được chấp nhận. Bạn có thể sử dụng chữ hoa ở trên cho các định nghĩa lớp, nhưng còn về các biến mẫu:

XmlReader xmlReader; 

Ở đây bạn phải sử dụng chữ thường.

Answer 3

Đối với từ viết tắt tôi sử dụng các nguyên tắc sau:

• Nếu viết tắt là chiều dài 2, đặt từ viết tắt trong trường hợp trên.

  For Ex : UIRule 
  

• Nếu viết tắt là chiều dài hơn, tôi sử dụng vỏ pascal cho từ viết tắt

  For Ex : SmsValidation, XmlReader 
  

Answer 4

Có hai lý do:

1. Nó dễ dàng hơn để phân biệt nơi một từ viết tắt kết thúc và cái kia bắt đầu trong số nhận dạng nơi chúng được đặt sau mỗi khác, ví dụ trong XmlHtmlConverter. Bây giờ XML và HTML không phải là ví dụ tốt như vậy, bởi vì mọi người đều biết XML là gì và HTML là gì. Nhưng đôi khi bạn sẽ thấy từ viết tắt ít rõ ràng hơn và sau đó điều này trở nên quan trọng.
2. Eclipse thông minh với các từ và chữ cái đầu của chúng. Đối với XmlHtmlConverter, bạn có thể nhập XHC vào hộp thoại Loại Mở và nó sẽ tìm thấy nó. Đối với một số XMLHTMLConverter, tên viết tắt sẽ là XMLHTMLC, tất nhiên là dài hơn một chút.

Answer 5

Trường hợp Pascal được sử dụng trong khuôn khổ .NET.Vì vậy,

XmlReader

được ưa thích trong môi trường Microsoft.

Tôi phải đồng ý với AronVanAmmers rằng điều này dễ đọc hơn là giải pháp thay thế.

tham khảo: Microsoft Design Guidelines for Class Library Developers

Answer 6

Tôi tin rằng, nói chung, tên lớp nên được viết như bạn mong đợi họ được đọc. Ví dụ, khi nói tên lớp to, tôi sẽ nói "đầu đọc X-M-L", vì vậy tôi sẽ đặt tên lớp là "XMLReader". Tuy nhiên, tôi sẽ đặt tên một lớp "REST service" giả định "RestService", vì, nói chung, "REST" không được phát âm là "R-E-S-T" nhưng "phần còn lại". Đối với một cái gì đó như "SQL", tôi có thể đi một trong hai cách, kể từ khi một số người nói "S-Q-L" và những người khác nói "phần tiếp theo". Nhưng nó thực sự chỉ đi theo sở thích cá nhân.