Vài mẹo hữu ích khi đặt tên biến trong dự án của bạn

Đặt tên cho kiểu dữ liệu chuỗi (String)

Kiểu dữ liệu chuỗi là cực kỳ phổ biến, kể cả đối với các thực thể thực tế, ví dụ như tên - name, tiêu đề - title...

Đôi lúc tôi cần lưu trữ một kiểu dữ liệu số như là một chuỗi, tôi sẽ tuân theo quy ước sau: someValueString hoặc là someValueAsString. Đoạn code sẽ trở nên dễ đọc và dễ hiểu hơn nhiều. 

Ví dụ:

//Javascript
const year = parseInt(yearAsString); 

Mảng, danh sách, bộ dữ liệu (Array, Collection, Set)

Khi đặt tên cho những biến kiểu này, tôi luôn dùng danh từ số nhiều, ví dụ như customers, errors, tasks,... Trong đa số trường hợp, điều này đủ, bởi bạn không cần biết rõ cách hiện thực khi chạy qua vòng lặp.

Trong một vài trường hợp khác, tôi có thể chỉ định cách hiện thực trong biến, ví dụ: queueOfTasks, stackOfCards, orderedSetOfTimestamps..., nhưng tôi chưa bao giờ đặt tên biến kiểu customerList, handledOperationSet... Nó hết sức dư thừa và dài dòng khi chỉ cần đặt customers, hoặc handledOperations... là người ta đã hiểu rõ.

Biến mapping (hay key/value)

Biến mapping thường được sử dụng cho việc get giá trị (value) từ một từ khóa (key) cụ thể. Trong trường hợp này, tôi tuân theo nguyên tắc keyToValueMap. Chằng hạn như chúng ta có một mapping value chứa tổng các đơn hàng của một khách hàng, chúng ta có thể đặt biến customerToOrderCountMap. 

Đặt tên theo cặp (Pair) và bộ (Tuple)

Trường hợp này khá đơn giản.

Tôi đặt tên biến cặp theo chuẩn variable1AndVariable2, biến bộ theo chuẩn variable1Variable2Variable3AndVariableN.

Ví dụ: heightAndWidth, heightWidthAndDepth...

Đặt tên cho các đối tượng (Object)

Các objects được xem như là một hiện thực của lớp (instance of class). Các class là một danh từ với ký tự đầu tiên được viết hoa, ví dụ như Person, Account, User, Order, Product... Tên biến cần phải liên kết với tên class, ví dụ Person $person, Account $account, Order $order... Bạn cũng có thể mô tả tính chất của biến bằng một tính từ đằng trước, ví dụ như Account $deletedAccounts, Order $completedOrders... Điểm mấu chốt ở đây là chúng ta cần giữ tên class cho phần cuối cùng của tên đối tượng.

Đặt tên cho các tham số của function

Phần này không khác với cách đặt tên ở những phần trên, nhưng bạn có thể thêm tiền tố "_" vào đằng trước của biến trong một số trường hợp.

//PHP
function getProductName (Product $product)
{
    ...
}

//SCSS
@function calculate-rem($_target, $_context: 16) {
    @return ($_target / $_context) * 1rem;
}

Đặt tên cho các hằng số (Constant)

Các hằng số là một trường hợp đặc biệt. Tôi luôn luôn đặt tên hằng số theo chuẩn snake_case với toàn bộ các ký tự viết hoa. 

Ví dụ: TOOLTIP_SHOW_DELAY_IN_MILLISECS. 

Các quy tắc chung

- Tránh viết tên biến tắt một cách tối nghĩa.

Cố gắng tránh viết tắt hết sức có thể. Tuy nhiên có rất nhiều tên viết tắt có thể sử dụng, ví dụ như Str thay cho String, Num thay cho Number, Prop thay cho Property... Các tên biến kiểu này khá phổ biến giữa các lập trình viên nên việc viết chúng hầu như không gây khó khăn cho người khác khi đọc. Nhưng bạn nên tránh việc viết tắt cho các trường hợp không phổ biến. Tôi hầu như chỉ viết tắt để tránh việc kéo dài lê thê tên biến của mình.

- Tránh những tên biến quá ngắn hoặc vô nghĩa.

Tên quá ngắn hầu như không thực sự chỉ rõ ý nghĩa của chúng. Tôi không sử dụng biến $i hay $k, thay vào đó tôi dùng $postIndex hoặc $postKey. Tôi hầu như không đặt các tên biến kiểu $num, $tmp, hay $val... Tôi thích mô tả chúng rõ ràng hơn là đánh đố người khác như vậy.