Đặt tên biến như thế nào cho chuẩn

Đặt tên biến như thế nào?

Mới nghe qua thì đây có vẻ như đây là một vấn đề hết sức đơn giản chúng ta không cần bận tâm tới làm gì. Có người còn cho rằng việc này dễ tới mức chúng ta không cần tốn công để nói về nó, đến cả người không rành code làm cũng được. Nhưng nếu bạn là một người code nhiều, đã từng tham gia vào các dự án lớn, hoặc những dự án đông người tham gia, thì chắc hẳn bạn sẽ hiểu được tầm quan trọng của việc đặt tên biến, thậm chí bạn có thể đã từng vày tai bứt óc để suy nghĩ 1 cái tên cho 1 cái biến trời ơi đất hỡi nào đó.

Vậy phải đặt tên biến như thế nào mới chuẩn?

Chắc hẳn là dân lập trình, bạn cũng đã từng đọc qua, hoặc ít nhất là nghe qua cuốn sách CLEAN CODE của tác giả Robert Cecil Martin. Vậy thì hãy xem qua một số quy tắc để đặt tên biến chuẩn "clean code" nào

Tên phải thể hiện được mục đích và ý nghĩa của nó

Có lẽ đây là quy định quan trọng nhất trong việc đặt tên biến như thế nào cho chuẩn. Bạn hãy chọn tên mà khi người khác đọc vào họ có thể hiểu được mục đích bạn dùng nó để làm gì, ý nghĩa của nó ở những nơi bạn gọi. Ví dụ, bạn có 1 list các active users, và 1 list các blocked users trong hệ thống thì thay vì chọn tên như list1, list2 bạn hãy lưu chúng dưới những cái tên rõ ràng như list_active_users, list_blocked_users. Vì những cái tên như list1, list2 nó không có ý nghĩa và có thể gây khó khăn cho bạn khi đọc lại chính code của mình. Suy nghĩ một cái tên chuẩn sẽ mất vài giây nhưng nó sẽ tiết kiệm hàng giờ đồng hồ cho bạn và đồng đội của bạn.

Tránh những sai lệch không đáng có

Hãy cẩn thận với những cái tên dài mà chỉ có 1 khác biệt nhỏ

• list_of_student_in_class_12t1_will_graduate_in_2017.
  

• list_of_student_in_class_12d1_will_graduate_in_2017.
  

  Trong lúc đang đau đầu vì những con bug không biết lí do, liệu bạn có chắc chắn mình sẽ không bị nhầm lần với 2 biến trên hay không. Hay thậm chí là I (i in hoa) và l (L viết thường)

Tính nhất quán của tên biến

Nếu bạn đã dùng people để chỉ người thì đừng dùng person nữa, client với customer hãy chọn 1 để chỉ khách hàng

Tránh những ký tự dư thừa

Tránh những kí tự đặt phía trước như tiền tố m hay thêm kiểu dữ liệu vào đầu tên biến. Điều đó khá là dư thừa và không cần thiết lắm, tất nhiên là có những trường hợp cần thiết thì phải đặt rồi

Quy ước đặt tên class và method

Việc đặt tên không chỉ dừng lại ở đặt tên biến, việc đặt tên class và method cũng phải chuẩn. Tuy nhiên theo quy ước, tên class hoặc object nên dùng danh từ hoặc cụm danh từ để đặt, còn tên mothod nên dùng động từ hoặc cụm động từ. Ví dụ như: class: user, company, ... method: get_all_users, create_new_company, ... Trên đây là một số tổng hợp các bạn có thể tham khảo để đặt tên biến một cách rõ ràng và chuyên nghiệp. Hãy bỏ vài giây, thậm chí vài phút để suy nghĩ một cái tên, nó sẽ tiết kiếm hàng tiếng đồng hồ cho bạn và đồng đội sau này.

Bài viết có tham khảo từ https://techtalk.vn/dat-ten-bien-nhu-the-nao-de-chuan-clean-code.html