Clean Code là mã nguồn được viết một cách rõ ràng, dễ hiểu và dễ bảo trì, có thể được đọc và hiểu bởi những lập trình viên khác (hoặc ngay cả chính người viết mã sau một thời gian dài) mà không cần quá nhiều chú thích. Clean Code không chỉ là về cú pháp mà còn liên quan đến phong cách lập trình và tổ chức mã. Clean Code gồm 4 nguyên tắc cơ bản, đó là: Nguyên tắc đặt tên, nguyên tắc viết hàm, nguyên tắc viết comment và nguyên tắc xử lý lỗi. Bài này sẽ giới thiệu về nguyên tắc đầu tiên của Clean Code: Nguyên tắc đặt tên.
1. Đặt tên có chủ đích
Đặt tên cho biến, hàm, và các cấu trúc khác trong mã sao cho người đọc có thể dễ dàng hiểu được ý nghĩa và chức năng của chúng mà không cần phải đoán hoặc đọc thêm tài liệu.
Ta có ví dụ sau:
Nếu chỉ nhìn vào hàm này ta sẽ không hiểu tác dụng của hàm này và tên các biến có tác dụng gì. Đoạn mã trong hình vi phạm nhiều nguyên tắc của Clean Code do cách đặt tên hàm và biến không rõ ràng, làm cho mã khó đọc và khó hiểu. Ta nên sửa lại như sau:
Đoạn mã sau khi cải tiến đã tuân thủ các nguyên tắc Clean Code, làm cho mã dễ đọc, dễ bảo trì và ít nhầm lẫn hơn.
2. Sử dụng tên theo nghiệp vụ
Tên biến nên được đặt theo ngữ cảnh của nghiệp vụ mà đoạn code đó đang giải quyết, không nên sử dụng các từ ngữ trong lập trình để đặt cho tên biến.
Ví dụ: nên đặt tên biến là accounts thay cho accountArray hay accountCollection.
Ta có mẫu code sau:
Tên accounts có thể ngắn gọn và tự nhiên hơn so với accountList. Trong trường hợp không cần nhấn mạnh loại dữ liệu, ta có thể sử dụng tên mô tả nội dung, giúp mã ngắn gọn mà vẫn giữ nguyên ngữ cảnh.
Những cải tiến nhỏ được đề xuất ở trên sẽ giúp mã ngắn gọn hơn và giữ được tính rõ ràng.
3. Thống nhất cách dùng từ
Hãy sử dụng một từ nhất quán trên toàn bộ chương trình để diễn tả cho một hành động hay một khái niệm nào đó.
Ví dụ: Khi chúng ta muốn viết phương thức lấy dữ liệu trong một class, có rất nhiều tên có thể sử dụng như getData, retriveData, fetchData … Tuy nhiên, hãy sử dụng một từ duy nhất ở tất cả các class (getData chẳng hạn) để người đọc không bị bối rối khi nhìn thấy nhiều cái tên với cùng một mục đích.
Ta có mẫu code sau:
Hàm trên sử dụng 2 từ khác nhau cho cùng một chức năng thêm. Vậy nên sẽ gây nhập nhằng và đôi khi khó hiểu cho người đọc.
Sau khi sửa cách dùng từ thì các hàm trở nên đồng bộ.
4. Tên lớp và tên phương thức
Có hai quy tắc đơn giản giúp chúng ta đặt tên cho method và class:
+ Tên class nên có danh từ hoặc cụm danh từ: Student, ClassRoom, School.
+ Tên method nên có động từ hoặc cụm động từ: countStudent, showName.
Ta có mẫu code tuân thủ nguyên tắc sau, nhờ vào cách đặt tên đúng đắn, ta có thể nhận ra ngay tác dụng của Class, hàm:
5. Sử dụng tên dễ phát âm và tìm kiếm được
Khi viết những tên biến hay tên hàm cần kết hợp nhiều từ với nhau, lập trình viên có xu hướng dùng từ mới rất khó hoặc không thể phát âm được. Thay vào đó, hãy viết đầy đủ tên của class đó.
Ta có ví dụ sau:
Khi viết tắt tên hàm sẽ gây khó hiểu, khó phát âm làm cho lập trình viên tốn thời gian để kiểm tra lại.
Với cách viết lại này, hàm trở nên dễ hiểu và dễ đọc hơn. Người lập trình viên chỉ cần nhìn tên hàm sẽ đoán ra tác dụng.
Tổng kết
Quy tắc đặt tên trong Clean Code đóng vai trò quan trọng trong việc nâng cao chất lượng mã nguồn và khả năng duy trì của dự án. Quy tắc này giúp giảm thiểu lỗi tiềm ẩn, vì các tên rõ ràng sẽ làm cho ý định lập trình trở nên minh bạch hơn. Nhờ vào việc áp dụng quy tắc đặt tên, các dự án phần mềm có thể trở nên dễ bảo trì và dễ phát triển trong dài hạn, giúp đội ngũ phát triển tối ưu hiệu quả làm việc và giảm thiểu rủi ro.
