Rule 10 — Comment / code style¶
- Code viết theo style của file xung quanh; không tự ý đổi convention hiện có.
- Comment giải thích vì sao (why), không kể lại cái gì (what) đã rõ từ code.
- Không để dead code, code comment-out,
console.logdebug, TODO không có issue id. - Mọi đường tắt đánh dấu
shortcut: <upgrade path>(Rule 05). - Đặt tên rõ nghĩa, tiếng Anh (Rule 11); không viết tắt khó hiểu.
Kiểm tra được¶
- Diff không có
console.log/printdebug không chủ đích. minimal-code-reviewskill báo dead code còn sót.