Nếu nghi ngờ, hãy đánh vần nó ra.
Điểm của một tên biến là để ý nghĩa của mã rõ ràng hơn. Trừ khi viết tắt là rất rõ ràng, sau đó bạn cũng có thể chỉ sử dụng từ nhỏ nhất có thể. Tên biến và tên hàm thường là các bit duy nhất của ngôn ngữ con người trong mã và do đó đóng vai trò là 'cột mốc' cho mắt người để tìm các phần mã có liên quan (hoặc, trong một cơ sở mã lớn, các công cụ như grephoặc ack) và cũng là đầu mối để hiểu
Khi người tiếp theo đến đọc mã của bạn, họ sẽ cảm ơn bạn vì điều đó. Người đó cũng có thể là bạn trong một năm. Tôi có rất nhiều mã tôi hối tiếc viết tắt, vì vậy ngày nay tôi cố gắng tránh nó.
Bạn có thể viết tắt khi ...
... Khi dạng viết tắt được sử dụng trong tiếng Anh nói hoặc viết bởi không chỉ những người làm việc trong dự án của bạn (nhiều từ điển đưa ra loại thông tin này bên cạnh thuật ngữ họ định nghĩa).
var extensible_markup_language_element; // don't do this
var xml_element; // better
var element; // possible if the name of the function or the documentation make it clear you're dealing with XML and not the periodic table
docs.toString(); // most people capable of reading code know docs == documentation
... Khi chữ viết tắt đề cập rõ ràng đến một khái niệm duy nhất và sẽ được nhận ra ngay lập tức bởi một người không quen thuộc với cơ sở mã. Thậm chí sau đó một bình luận hoặc một phần của tài liệu giúp.
var auth = user.auth;
if (auth) // If the user is authenticated?
// If the user is authorised to do something?
// If the authentication function exists for that user group?
// If some setting called auth is turned on for that user?
// If the user is the author of the document in question?
// If the user has some authority?
var attrNames = retrieveAttrs();
if (attrNames) // hm, attrNames sounds like an array of strings - which will be boolean true even if empty - this if looks like a bug!
const MDF // author is writing an iOS app for ordering hand-carved artisanal fibreboard so anyone familiar with the problem domain knows this has plainly nothing to do with Microsoft Database Files. Though maybe the first time it comes up in the code the author should perhaps still put its full name
... Khi tên biến chỉ tồn tại trong một phạm vi hoặc hàm nhỏ và bạn không mong muốn người dùng rút ra ý nghĩa từ tên đó, hãy sử dụng một ký tự. Trong những trường hợp như vậy, ivà jlà phổ biến.
foreach $i (1..10) { say $announcement->[$i] }
... Khi viết một giao diện (nghĩa là không phải là tên biến, vì vậy ngoài phạm vi câu hỏi, chỉ được đề cập vì tên biến và giao diện đặt chúng thường sử dụng cùng một từ vựng), ví dụ trong trường hợp các quy tắc khác có thể áp dụng:
some_command --transaction-message "Done" # a bit wordy - keep, but ALSO allow for convenience:
some_command --msg "Done" # might be useful
some_command -m "Done" # if you can spare -m
... Khi codebase của bạn cần tham chiếu cùng một khái niệm nhiều lần trong cùng một dự án và khi viết tắt có thể được định nghĩa trong một hướng dẫn kiểu cho dự án đó và khi nó không rõ ràng. Nếu dự án của bạn không đủ lớn cho một hướng dẫn về phong cách thì nó không đủ lớn để nó xứng đáng.
Tôi sẽ không cung cấp một ví dụ mã cho cái này bởi vì theo định nghĩa, nó chỉ hoạt động trong một dự án lớn, nhưng cũng xem mục tiếp theo:
... Khi làm việc trên một dự án đã thành lập có nhiều người đóng góp và hướng dẫn về phong cách bắt buộc phải viết tắt. Trong trường hợp đó, chỉ viết tắt theo hướng dẫn kiểu, nhưng xem xét các vấn đề và sẵn sàng chú thích bằng các bình luận (như "đây là danh sách các tên thuộc tính dưới dạng chuỗi").
Các loại nên kết thúc bằng Tiếng _tv; Định nghĩa cấu trúc thô trong Tiếng _ cấu trúc
- https://metacpan.org/source/SHLOMIF/XML-LibXML-2.0117/HACKING.txt
Một suy nghĩ cuối cùng: nếu bạn vẫn có các tên biến dài không được chấp nhận (ví dụ: gồm bốn hoặc nhiều đơn vị ngữ nghĩa như TotalAfterTaxInLocalCurrency), thì đó có thể là một triệu chứng mà mã của bạn đang cố gắng thực hiện quá nhiều trong một phạm vi duy nhất và các hàm của nó cần được cấu trúc lại ra hoặc các biến của bạn có thể được quản lý logic hơn trong một đối tượng.