Biến nên được đặt tên Id hoặc ID? [đóng cửa]

Đây là một chút mô phạm, nhưng tôi đã thấy một số người sử dụng Idnhư trong:

private int userId;
public int getUserId();

và những người khác sử dụng:

private int userID;
public int getUserID();

Là một trong những cái tên tốt hơn so với cái khác? Tại sao? Tôi đã thấy điều này được thực hiện rất không nhất quán trong các dự án lớn. Nếu tôi đặt ra một tiêu chuẩn mà hầu hết mọi người sẽ quen thuộc? Đó là tiêu chuẩn thông thường?

Quy tắc quan trọng nhất cần tuân theo trong những trường hợp này là tính nhất quán: Làm như mọi người khác làm.

Chẳng hạn, hãy xem API XML của ngôn ngữ của bạn để xem cách chúng thực hiện.

Các lớp tên Java như SAXParser và DOMException , các lớp tên .NET như XmlDocument .

Dựa vào đó, tôi sẽ nói "ID" trong Java, "Id" trong C #.

Tuy nhiên, tôi đã thấy rằng Java EE 6 có một chú thích có tên @Id(xem tài liệu ), vì vậy có vẻ như Java coi "Id" chỉ là một từ bình thường.

Kiên định là vua; chọn cái này hay cái kia, nhưng làm nó nhất quán ở mọi nơi

Điều đó nói rằng, tôi thích biến thể đầu tiên, vì nó không vi phạm camelCase (làm như vậy có nghĩa là bạn có hai quy tắc kiểu để nhớ, không chỉ một).

Hai chữ in hoa đôi khi được sử dụng vì điều này , nhưng ID thực sự chỉ là một hình thức ủy quyền Id.

TL; DR: Trong ngữ cảnh của các thư viện lớp .NET, Microsoft khuyên bạn nên sử dụng Id. Điều này hơi phản trực giác, vì đây là một ví dụ hiếm hoi của một từ viết tắt được cho phép / khuyến nghị (viết tắt thường được tán thành).

Nếu chúng ta đang nói về các quy ước thư viện lớp C # hoặc .NET, Microsoft có sẵn một số nguyên tắc đặt tên được xác định khá rõ . Họ đã suy nghĩ rất kỹ, với nhiều lời giải thích về nhiều vấn đề khác nhau - thực ra, mọi nhà phát triển nên dành chút thời gian để đọc toàn bộ phần Nguyên tắc thiết kế .

Khi nói đến các từ viết tắt , quy tắc của ngón tay cái là: đối với hai từ viết tắt, bạn có xu hướng giữ chữ hoa (trong trường hợp Pascal được áp dụng), vì vậy, ví dụ IOStreamcó thể là tên của một lớp. Đối với từ viết tắt dài hơn, bạn viết thường phần còn lại của từ viết tắt, ví dụ XmlDocumenthoặc HtmlParser. Đây thực sự là một quy tắc hầu như không rõ ràng (không có sự nhầm lẫn về việc một từ kết thúc và từ tiếp theo bắt đầu, trừ khi bạn đang xâu chuỗi các từ viết tắt hai chữ cái) và bạn nhanh chóng làm quen với nó.

Vì vậy, nó là ID, hay Id? Theo Microsoft, nó có thể không như bạn nghĩ:

Từ viết tắt khác với chữ viết tắt ở chỗ chữ viết tắt rút ngắn một từ. Ví dụ: ID là tên viết tắt của mã định danh . Nói chung, tên thư viện không nên sử dụng chữ viết tắt.

Hai chữ viết tắt có thể được sử dụng trong định danh là ID và OK. Trong các định danh vỏ Pascal, chúng sẽ xuất hiện dưới dạng Id và Ok. Nếu được sử dụng làm từ đầu tiên trong mã định danh vỏ lạc đà, chúng sẽ xuất hiện dưới dạng id và ok, tương ứng.

Thông thường, tôi không thực sự chắc chắn khi nào sự khác biệt này bắt đầu xuất hiện trong hướng dẫn, nhưng một vài năm trước (khoảng 3.0 / 3.5) xu hướng đặt tên chung trong các thư viện lớp đã chuyển từ ID sang Id.

Tôi đã đọc một lời giải thích rất tốt trong tài liệu của một số công ước mã hóa. CamelCase phải luôn được sử dụng cho các từ viết tắt và viết tắt, bởi vì nó dễ dàng hơn để phân biệt ranh giới từ (so XmlIdWritervới XMLIDWriter).

Như chúng ta có thể thấy trong hàm mặc định của JavaScript getEuityById (); Id được viết trong trường hợp lạc đà ...

Sử dụng 'id' nếu sử dụng với dấu gạch dưới. Ví dụ: user_id

Sử dụng 'Id' nếu đặt tên var mà không có Dấu gạch dưới để phân biệt các từ khác nhau. Ví dụ: userId

Nếu nó là một biến từ duy nhất thì nó phải ở dạng chữ thường hoàn chỉnh, nếu nhiều từ var thì sử dụng trường hợp Camel thấp hơn. Ví dụ: thisIsExample

Nhưng tôi thực sự không khuyến nghị 'ID' tất cả trong CAPS vì chúng tôi thường sử dụng tất cả các giới hạn để xác định CONSTANTS.

Đầu tiên, viết tắt eschew.

Thứ hai, nếu chữ viết tắt là siêu nổi tiếng, tôi khuyên bạn nên sử dụng vỏ lạc đà.

Đó là bởi vì bạn không cần phải xem xét ý nghĩa của điều đó. chỉ coi như một từ bình thường