Công ước đặt tên Java với các từ viết tắt [đã đóng]

Tên chính xác cho lớp Java sau: DVDPlayerhoặc là DvdPlayergì?

Vì có vẻ như câu trả lời là không có tiêu chuẩn duy nhất cho điều này trong Java, nên tôi muốn lưu ý rằng Nguyên tắc thiết kế .NET Framework chỉ định điều này.

Bây giờ trước khi đánh tôi vì lạc đề, xin hãy nhớ rằng các hướng dẫn đặt tên lớp cho Java và .NET Framework khá giống nhau, điều này làm cho các hướng dẫn .NET hữu ích như một tài liệu tham khảo thuyết phục.

Quy tắc chung

Cả hai hướng dẫn chỉ khuyến nghị sử dụng các từ viết tắt khi từ viết tắt được biết đến rộng rãi và được hiểu rõ. DVD hoặc XML là những ví dụ tuyệt vời về điều này, vì trong khi bạn sẽ nhận ra chúng ngay lập tức, sẽ mất một chút thời gian để nhận ra phiên bản mở rộng.

Các từ viết tắt

Nguyên tắc .NET Framework khuyên bạn không nên sử dụng các từ viết tắt (trái ngược với các từ viết tắt), ngoại trừ hai từ viết tắt phổ biến 'ID' và 'OK' có thể được sử dụng trong các định danh. Khi sử dụng chữ viết tắt, trường hợp hỗn hợp Idluôn được sử dụng ngoại trừ từ đầu tiên của mã định danh camelCase (trái ngược với mã định danh PascalCase).

Trong Java quy ước này chỉ được tuân theo một số thời gian. Hãy xem cách trộn lẫn các cách viết getIDvà getIdtrong JCL. (Di chuyển giữa chừng trang đó). Trong phiên bản Java 8 , mặc dù getIdđược sử dụng ngày càng nhiều, trong đó gợi ý các quy ước PascalCase được ưa chuộng hiện nay. Tốt nhất là chỉ nên tránh viết tắt hoàn toàn khi có thể.

Từ viết tắt ngắn

Nguyên tắc .NET Framework nói rằng hai từ viết tắt như 'IO', nên có cùng một trường hợp cho cả hai chữ cái. Vì vậy, đối với mã định danh PascalCase (như tên lớp) bạn sẽ nhận được DBRate, trong khi đối với mã định danh camelCase (như biến cục bộ) bạn có thể có ioChannel.

Đây chắc chắn cũng là quy ước phổ biến trong Java.

Từ viết tắt dài

Các hướng dẫn của .NET Framework khuyến nghị các từ viết tắt ba chữ cái hoặc dài hơn sử dụng trường hợp hỗn hợp cho các định danh PascalCase và camelCase, ngoại trừ từ đầu tiên của định danh camelCase. Do đó, đối với một tên lớp bạn có thể có XmlDocument, trong khi một biến cục bộ có thể được đặt tên httpRequest.

Quy ước này không phải lúc nào cũng được tuân theo trong Java. Bốn từ viết tắt ký tự dường như thường sử dụng trường hợp hỗn hợp, nhưng ngay cả JCL cũng không nhất quán về ba từ viết tắt. Hầu hết trong số chúng dường như đều là chữ hoa, như 'URL', 'XML', 'SQL' và 'DOM', nhưng có một số trường hợp ngoại lệ như 'Jar'.

Phần kết luận

Đối với Java:

Đối với 4+ chữ viết tắt, sử dụng trường hợp hỗn hợp. Thư viện tiêu chuẩn thực hiện điều này, và nó chỉ có ý nghĩa tốt.

Đối với các từ viết tắt 3 chữ cái, bạn có thể sử dụng tất cả chữ hoa như JCL hoặc bạn có thể sử dụng trường hợp hỗn hợp như .NET Framework. Dù bằng cách nào, hãy kiên định.

Đối với 2 từ viết tắt, sử dụng tất cả chữ hoa.

Đối với chữ viết tắt 2 chữ cái, Java không thực sự có một tiêu chuẩn, nhưng tôi khuyên bạn nên sử dụng trường hợp hỗn hợp, trừ khi tính nhất quán với các tên khác sẽ làm cho tất cả chữ hoa trông đẹp hơn.

Không có câu trả lời "đúng". Chỉ cần một tập hợp các thực tiễn và quy ước chơi tốt hơn với các công cụ khác của bạn.

Vì vậy tôi thích DvdPlayer. Nó hữu ích hơn vì trong Eclipse bạn có thể thực hiện Ctrl+ Shift+ Tvà chọn các lớp theo chữ cái đầu tiên của mỗi từ.

Tôi đã thấy cả hai được sử dụng trong tự nhiên và Sun dường như đi DVDPlayertheo phong cách. DvdPlayerMặc dù vậy, tôi thích bởi vì theo cách đó thì rõ ràng ranh giới từ ngay cả khi có nhiều từ viết tắt liên tiếp, như trong HTTPURLConnection.

Tôi muốn định nghĩa các thể hiện riêng lẻ của các lớp theo cách sau:

Catalogue catalogue;
Person person;

Vì vậy, nếu tôi sử dụng DVDPlayer, tôi sẽ gọi một ví dụ về điều đó là gì? dVDPlayer? Do đó tôi sẽ chọn DvdPlayertên lớp, vì vậy bạn có thể đặt tên cho các thể hiện như thế nào dvdPlayer.

Một số ví dụ từ các lớp JavaSE, apache commons và spring:

• HttpURLConnection
• HTTPAddress
• UrlPathHelper
• AopProxy
• ISBNValidator

Vì vậy - nó không thực sự quan trọng.

Java hiệu quả dường như thích DvdPlayer hơn.

Như những người khác đã chỉ ra, đó là một phong cách khác nhau giữa các dự án. Các dự án của Google như Guava và GWT thích DvdPlayerphong cách này.

https://google.github.io/styleguide/javaguide.html#s5.3-camel-case

Từ tài liệu java mặt trời :

Tên lớp nên là danh từ, trong trường hợp hỗn hợp với chữ cái đầu tiên của mỗi từ nội bộ được viết hoa. Cố gắng giữ cho tên lớp của bạn đơn giản và mô tả. Sử dụng toàn bộ từ - tránh các từ viết tắt và viết tắt (trừ khi chữ viết tắt được sử dụng rộng rãi hơn nhiều so với dạng dài, chẳng hạn như URL hoặc HTML).

DVDPlayerlà tiêu chuẩn, nhưng DvdPlayerkhông phải là hiếm.

Bạn thường xuyên hơn không nhìn thấy getId. Điều đó có lẽ là do suy nghĩ ID là sự rút ngắn của "Danh tính". Nó thực sự là tên viết tắt của Chứng minh thư.

HttpURLConnectionthường được đưa ra như một ví dụ về quy ước hỗn hợp. Tuy nhiên, "http" được sử dụng làm tên giao thức trong URL phải là chữ thường (mặc dù chữ hoa thường được chấp nhận).

Không có "chính xác", chỉ có sở thích ở đây.

Sun nhất quán trong cách họ đặt tên các lớp có chứa "URL" và "HTML", nhưng tôi thấy HTTP sử dụng cả mũ và vỏ lạc đà trong javadocs.

Cá nhân, tôi thích DvdPlayer hơn.