Bài viết được dịch từ Gist của wojteklu.
Code sạch khi nó có thể được hiểu bởi tất cả mọi người trong team. Code sạch có thể được một lập trình viên khác ngoài chính tác giả đọc và cải tiến. Code dễ hiểu sẽ dễ đọc, dễ sửa, dễ cải tiến và dễ bảo trì.
Quy tắc chung
- Tuân theo các quy ước chuẩn.
- Suy nghĩ đơn giản thôi, viết code cũng đơn giản thôi.
- Luôn dọn code sạch sẽ hơn lúc bạn nhận nó, dù là code của mình hay người khác.
- Luôn tìm nguyên nhân cốt lõi của vấn đề.
Quy tắc thiết kế
- Dữ liệu tùy chỉnh/cấu hình thì nên đặt ở level cao.
- Thay vì dùng if/else hoặc switch/case, nên vận dụng tính đa hình.
- Tách code đa luồng.
- Đừng lạm dụng configurability?
- Sử dụng dependency injection.
- Tuân theo Định luật Demeter
Mẹo để code dễ hiểu
- Thống nhất cách làm. Nếu bạn quen với một cách nào đó thì hãy áp dụng cách đó cho những thứ tương tự.
- Đặt tên biến có nghĩa.
- Khai báo biến để chứa các giá trị biên. Ví dụ:
// ❌ const arr = [1, 2, 3]; for (let i = 0; i <= arr.length - 1; i++) { } // ✅ const arr = [1, 2, 3]; const lastIndex = arr.length - 1; for (let i = 0; i <= lastIndex; i++) { } - Nếu có thể, chọn 'value object' thay vì kiểu dữ liệu nguyên thủy.
- Tránh sự lệ thuộc về logic. Ví dụ khi xây dựng method, không nên cho method đó lệ thuộc một điều kiện nào đó trong cùng một class.
- Tránh dùng điều kiện phủ định.
Quy tắc đặt tên
- Đặt tên rõ ràng, mô tả được công dụng.
- Dễ phân biệt.
- Dễ đọc.
- Dễ tìm.
- Không nên dùng số trực tiếp trong code mà phải đặt tên cho nó. Ví dụ:
// ❌ if (gender === 0) { } else if (gender === 1) { } else { } // ✅ const MALE = 0; const FEMALE = 1; if (gender === MALE) { } else if (gender === FEMALE) { } else { } - Không nên chèn tiền tố hay kiểu dữ liệu vào tên. Ví dụ:
// ❌ let sName = "Robert C. Martin"; let roleList = ["User", "Admin", "Mod"]; // ✅ let name = "Robert C. Martin"; let roles = ["User", "Admin", "Mod"];
Tham khảo thêm: Naming rules - Các quy tắc vàng trong làng đặt tên
Quy tắc của hàm
- Nhỏ.
- Chỉ làm một việc.
- Tên dễ hiểu.
- Chỉ nên có ít đối số.
- Không có tác dụng phụ.
- Không được dùng đối số dạng flag mà phải tách nhỏ hàm ra thành nhiều hàm độc lập để dễ gọi cũng như test. Ví dụ:
// ❌ function setConfig(name, value) { if (name === "theme") { this._theme = value; } if (name === "font") { this._font = value; } } // ✅ function setTheme(value) { this._theme = value; } function setFont(value) { this._font = value; }
Quy tắc comment
- Code nên dễ hiểu để không lệ thuộc nhiều vào comment.
- Không comment dư thừa.
- Không comment những điều quá rõ ràng, dễ nhận biết. Ví dụ:
/** * Hàm thêm role vào database. */ function addRole(role) { db.roles.add(role); } - Không comment khi đóng thẻ/ngoặc. Ví dụ:
<!DOCTYPE html> <html lang="en"> <!-- mở head --> <head> ... </head> <!-- kết thúc head --> <!-- mở body --> <body> ... </body> <!-- kết thúc body --> </html> - Không comment đoạn code không còn sử dụng, xóa nó luôn.
- Comment lý do tại sao code được viết như vậy (code lạ, trường hợp bất khả kháng).
- Comment để làm rõ ý nghĩa của code (logic phức tạp).
- Comment cảnh báo hậu quả.
Cấu trúc code
- Phân chia code theo chiều dọc.
- Những code liên quan nhau nên viết liền nhau (theo chiều dọc).
- Khai báo biến gần chỗ nó được sử dụng.
- Các hàm liên quan nhau nên đặt gần nhau.
- Các hàm giống nhau nên đặt gần nhau.
- Các hàm nên viết từ trên xuống dưới.
- Mỗi dòng code nên ngắn.
- Không cân chỉnh code theo chiều ngang. Ví dụ:
// ❌ const PI: number = 3.14; let radius: number = 10; let area: number = 2 * PI * radius; // ✅ const PI: number = 3.14; let radius: number = 10; let area: number = 2 * PI * radius; - Dùng khoảng trắng một cách hợp lý để liên kết những thứ liên quan và tách những thứ ít liên quan với nhau.
- Đừng ngắt thụt đầu dòng. Ví dụ:
// ❌ if (isUser) loadUserPage(); else redirectHome(); // ✅ if (isUser) loadUserPage(); else redirectHome();
Cấu trúc dữ liệu và object
- Ẩn cấu trúc nội bộ.
- Dùng cấu trúc dữ liệu nếu có thể.
- Tránh cấu trúc hỗn hợp, nửa này nữa kia.
- Nhỏ.
- Chỉ làm một việc.
- Chỉ dùng một ít biến instance.
- Cha không được nhìn con. (Base class không nên biết các child class trông như thế nào)
- Tạo nhiều hàm thay vì truyền đối số vào duy nhất một hàm rồi xử lý theo đối số đó.
- Nên dùng non-static thay vì static method.
Kiểm thử (test)
- Mỗi test chỉ nên kiểm tra một thứ.
- Dễ đọc.
- Nhanh.
- Độc lập.
- Có thể lặp đi lặp lại.
Code thúi
- Quá cứng nhắc, khó thay đổi. Một thay đổi nhỏ mà dẫn tới một loạt những thay đổi khác.
- Mong manh, dễ vỡ. Chỉ sửa một chỗ mà gây ra lỗi một đống chỗ.
- Bất động. Code không thể được tái sử dụng trong những dự án khác, vì quá nhiều rủi ro và tốn effort.
- Phức tạp hóa không cần thiết.
- Lặp lại không cần thiết.
- Code khó hiểu.
