Clean Code không phải là làm code trở nên cầu kỳ. Mục tiêu của code sạch là giúp người đọc hiểu nhanh ý định, biết nơi cần sửa và tự tin thay đổi mà không phá vỡ phần còn lại của hệ thống.
Tên biến và hàm phải nói đúng nghiệp vụ
Tên tốt giúp giảm nhu cầu giải thích bằng comment. Trong hệ thống quản lý hồ sơ, tên như approvedLicense, monitoringReport hay expiredDocument dễ hiểu hơn nhiều so với data1 hoặc listItem.
Khi đặt tên, nên ưu tiên ngôn ngữ nghiệp vụ mà cả lập trình viên và người phân tích hệ thống cùng hiểu. Đây là cách giảm khoảng cách giữa tài liệu yêu cầu và code triển khai.
- Tên hàm nên bắt đầu bằng động từ thể hiện hành động.
- Tên biến boolean nên thể hiện trạng thái đúng hoặc sai.
- Tránh viết tắt khó hiểu nếu không phải thuật ngữ quen thuộc.
Hàm nhỏ và có trách nhiệm rõ
Một hàm vừa kiểm tra dữ liệu, vừa ghi database, vừa gửi email và ghi log sẽ rất khó test. Khi tách thành các bước nhỏ, mỗi phần có thể được kiểm thử và thay đổi độc lập.
Trong dự án Laravel, có thể tách validate ở Request, nghiệp vụ ở Service, định dạng response ở Resource và thao tác lặp lại ở Job hoặc Action. Không phải dự án nào cũng cần nhiều lớp, nhưng trách nhiệm cần rõ.
Comment nên giải thích lý do
Comment kiểu mô tả lại dòng code thường không giúp ích. Comment hữu ích là comment giải thích vì sao có nhánh xử lý đặc biệt, vì sao phải giữ tương thích với dữ liệu cũ hoặc vì sao chưa thể tối ưu ngay.
Một nguyên tắc thực tế là: nếu có thể đổi tên biến hoặc tách hàm để code tự rõ nghĩa, hãy làm điều đó trước khi thêm comment.
- Viết test cho nghiệp vụ quan trọng.
- Xóa code không còn dùng thay vì để comment lại.
- Dùng formatter thống nhất để giảm tranh luận về style.
Tóm tắt ý chính
- Code sạch giúp giảm chi phí bảo trì.
- Tên tốt và hàm nhỏ quan trọng hơn comment dài.
- Clean Code cần được duy trì bằng review và test.