Comment trong lập trình: Khi nào cần và không cần dùng

Trong cuốn sách 'Clean Code' của tác giả Robert C. Martin, chương 4 sẽ giúp chúng ta hiểu rõ về vai trò của comment trong code. Tác giả cho rằng, một trong những lý do chính khiến lập trình viên thêm comment là do họ viết code chưa đủ rõ ràng. Khi mã nguồn đã rõ ràng và chứa đầy đủ thông tin, việc thêm comment trở thành không cần thiết. Dưới đây là một số nguyên tắc và quan điểm của tác giả về việc sử dụng comment trong code:

1. Luôn cố gắng giải thích bản thân trong mã nguồn

Thay vì sử dụng comment, hãy cố gắng làm cho đoạn mã có thể tự giải thích được ý nghĩa của nó. Việc tuân thủ quy tắc đặt tên và logic rõ ràng sẽ giúp mã nguồn trở nên dễ đọc hơn mà không cần thêm bất kỳ comment nào. Đừng quên phong cách mã hóa nhất quán!

2. Không lặp lại

Tránh đưa ra comment thừa thãi khi mã đã đủ rõ ràng. Để những comment có giá trị; chỉ sử dụng chúng khi phần mã không thể hiện được ý nghĩa ẩn sau. Ví dụ:

// Tệ:
// Đặt tên người dùng thành John
user.setName("John");

// Tốt:
user.setName("John"); // Đặt tên người dùng cụ thể để kiểm tra

3. Tránh tạo ra tiếng ồn hiển nhiên

Tránh việc thêm comment khi mã đã thể hiện đủ nghĩa. Comment trong trường hợp này có thể khiến mã trở nên khó hiểu hơn. Ví dụ:

// Tệ:
// Tăng biến đếm lên một
counter++;

// Tốt:
counter++;

4. Không sử dụng comment đóng ngoặc nhọn

Comment ở sau dấu “}” thường không cần thiết và có thể làm khó khăn trong việc đọc mã. Ví dụ:

// Tệ:
if (condition) {
    // một số mã
} // kết thúc if

// Tốt:
if (condition) {
    // một số mã
}

5. Không comment mã đã xóa. Chỉ cần gỡ bỏ.

Việc comment mã có thể tạo nhầm lẫn cho các lập trình viên khác bởi họ không thể biết lý do tại sao đoạn mã đó được comment lại. Quy trình kiểm soát phiên bản như Git có thể giúp ta xem lại mã mà không cần đến comment nữa. Ví dụ:

// Tệ:
// if (oldCondition) {
//     doSomethingOld();
// }
if (newCondition) {
    doSomethingNew();
}

// Tốt:
if (newCondition) {
    doSomethingNew();
}

6. Sử dụng để giải thích ý định

Trong một số trường hợp, mã nguồn không thể hiện đủ ý nghĩa của nó. Đây là lúc bạn nên sử dụng comment để giải thích lý do đằng sau quyết định của bạn. Ví dụ:

// Tính toán khoản thanh toán hàng tháng dựa trên lãi suất cố định.
double monthlyPayment = calculateMonthlyPayment(principal, interestRate, term);

7. Sử dụng để làm rõ mã

Nếu mã chứa công thức phức tạp hoặc thuật toán không phổ biến, hãy sử dụng comment để mô tả cách nó hoạt động hoặc dựa trên cái gì. Ví dụ:

// Chuyển đổi nhiệt độ từ Celsius sang Fahrenheit
double temperatureInFahrenheit = (temperatureInCelsius * 9/5) + 32;

8. Sử dụng để cảnh báo về hậu quả

Comment cũng có thể được sử dụng để cảnh báo về những đoạn mã có thể gây lỗi hoặc có tác dụng phụ. Điều này là cần thiết để giúp các lập trình viên khác tránh khỏi lỗi và cẩn thận hơn trong việc bảo trì mã. Ví dụ:

// Cảnh báo: Phương thức này không an toàn với đa luồng
public void updateSharedResource() {
    // mã để cập nhật tài nguyên chia sẻ
}

Tóm lại, một mã nguồn tốt và rõ ràng sẽ ít khi cần đến quá nhiều comment. Comment có thể trở thành con dao hai lưỡi: hữu ích khi được sử dụng đúng cách nhưng lại gây nhầm lẫn nếu lạm dụng. Mỗi dòng mã đều phải có ý nghĩa và giá trị của riêng nó!
source: viblo