Page 48 - Ký sự code dạo

LẬP TRÌNH VIÊN ĐÂU PHẢI CHỈ BIẾT CODE

comment lại một số code không dùng nữa. Một số lỗi khác mà các đạo
hữu này hay mắc phải như:

• Comment lại code cũ để “đề phòng”. Code không dùng nữa thì
xóa đi, đừng comment. Có SVN rồi thì khi cần code cũ chỉ việc
restore lại là xong.
• Comment để làm log. Đừng comment theo kiểu: //02/03/1992
Sửa tên class. Sử dụng SVN có thể tra ra log rõ ràng và tiện dụng
hơn nhiều.
Giai đoạn tạm chín chắn trong suy nghĩ (Biết cách comment)

Code một thời gian, hầu như mọi lập trình viên sẽ đạt đến giai đoạn
này. Ở giai đoạn này, ta đã cảm thụ được một chân lý võ học : Comment
nên là what, không phải how. Comment để nói code làm gì, không phải
để giải thích việc code làm.

Lúc này, lập trình viên đã hiểu rõ hơn về cách comment. Với những
đoạn code phức tạp, dài dòng, 1 dòng comment ngắn gọn sẽ giúp người
sau dễ dàng hiểu đoạn code làm gì:

public object DoThing() {
//Lấy 1 phần tử random từ database
//Một đống code phức tạp
return obj;
}
Tuy vậy, các bậc cao nhân xưa đã rút ra được một điều: Comment là
thứ dối trá. Khi sửa code, comment thường không được sửa, sẽ dẫn tới
tình trạng code một đằng, comment một nẻo. Ta phải đọc cả code lẫn
comment để biết code làm gì, phí gấp đôi thời gian. Cách comment tốt
nhất chính là dùng code, chính code sẽ nói code làm gì. Ngộ ra được
điều này, các đạo hữu sẽ đạt tới cảnh giới cuối cùng trong “code học”.
Cảnh giới vô kiếm thắng hữu kiếm (Vô comment thắng hữu
comment)
Đây là cảnh giới mà ta hy vọng các đạo hữu có thể đạt được. Ở cảnh
giới này, ta code không cần comment nhiều. Giống như Độc Cô Cầu Bại
có thể lấy kiếm gỗ làm kiếm, lấy lá cỏ làm kiếm, lấy tay làm kiếm; ta
thấy bất cứ thứ gì cũng có thể làm comment: tên biến cũng là comment,
tên hàm cũng là comment, tên database cũng là comment. Code cũng

46