Khi viết mã, điều đầu tiên trong đầu bạn là cách máy tính xử lý mã bạn viết. Tuy nhiên, cũng thiết yếu suy nghĩ về cách con người đọc mã của bạn.
Dù bạn làm dự án nhóm, hay tự xây dựng, bạn nên ghi chép mã đầy đủ. Đó là nơi comment (chú thích) xuất hiện.
Comment là một dòng hoặc nhiều dòng văn bản viết trong chương trình bị máy tính bỏ qua. Comment dùng giải thích ý định chương trình cho con người đọc mã, dù là bạn hoặc người khác.
Hướng dẫn này sẽ thảo luận cách viết comment trong Java và đi qua vài thực hành tốt (best practices) viết comment hiệu quả.
Comment Java
Nếu mới lập trình, bạn có thể hỏi: tại sao comment mã? Có vài lý do comment quan trọng.
Khi viết mã, quan trọng nhận ra mã sẽ được đọc bởi ai đó, ngay cả khi người đó là bạn. Thêm, không bảo chứng người đọc hiểu mã bạn viết.
Nếu làm việc đơn độc, mã không comment có thể gây bực bội, tốn thời gian tìm hiểu cách mã hoạt động. Nhưng nếu làm nhóm, không comment càng gây gián đoạn. Lập trình viên khác có thể phải hỏi về mã, tiêu tốn thời gian quý.
Tóm lại, viết comment làm mã dễ đọc hơn. Khi viết thủ tục phức tạp, có văn bản thuần túy bên cạnh mã giải thích ý định sau các dòng mã rất hữu ích. Comment bạn viết hữu ích tham khảo tương lai, đặc biệt khi làm việc với lập trình viên khác.
Comment tốt nhất giải thích ý định sau mã. Tại sao bạn làm theo cách đó, thay vì lặp lại dòng mã làm gì? Comment hiệu quả trả lời câu hỏi và cải thiện hiệu suất.
Cú pháp Comment Java
Trong Java, có hai loại doc comment: comment đơn dòng (single-line) và comment nhiều dòng (multi-line).
Comment Đơn dòng (Single-Line Comments)
Comment đơn dòng, thường gọi comment nội tuyến (inline), xuất hiện cuối dòng mã.
Comment nội tuyến thường dùng chú thích phần nhỏ mã kéo dài một dòng.
Giả sử viết chương trình in thông báo Hôm nay là thứ Sáu ra console. Muốn viết comment theo dõi mã. Ví dụ comment nội tuyến:
public class FridayMessage {
public static void main(String[] args) {
System.out.println("It's Friday!"); // in "It's Friday" ra console
}
}
Comment nội tuyến chỉ dùng khi cần giải thích ý định sau dòng mã cụ thể. Mã chứa nhiều comment nội tuyến nhanh trở nên khó đọc.
Lưu ý quan trọng: khi viết comment, mục tiêu nên giải thích ý định sau comment. Trong ví dụ trên, comment không hữu ích vì dễ thấy mã làm gì. Nhưng nếu dòng mã phức tạp hơn, comment có thể cần.
Comment Nhiều dòng (Multi-Line Comments)
Comment nhiều dòng, còn gọi block comment, dùng giải thích đoạn mã. Comment nhiều dòng kéo dài nhiều dòng và thường đặt đầu tệp hoặc trước khối mã bắt đầu.
Comment nhiều dòng bắt đầu bằng /* và kết thúc bằng */. Ví dụ comment nhiều dòng trong tệp nguồn Java:
/* Đây là ví dụ comment nhiều dòng.
Mã dưới in It's Friday! ra console.
*/
public class FridayMessage {
public static void main(String[] args) {
System.out.println("It's Friday!");
}
}
Trong ví dụ, comment xuất hiện ba dòng đầu mã.
Thường, comment nhiều dòng dùng đầu tệp ghi chú chi tiết tệp. Ví dụ, comment nhiều dòng có thể bao gồm thông tin tác giả, phiên bản tệp, và thông tin tương tự.
Comment mã để Kiểm thử (Testing)
Ngoài phục vụ tài liệu, comment cũng dùng ngăn mã thực thi trong giai đoạn kiểm thử và gỡ lỗi (debugging). Lập trình viên gọi là comment out code (comment mã ra).
Giả sử viết chương trình ném ngoại lệ (exception). Bạn chưa chắc lỗi gì, muốn comment phần mã giúp tìm nguồn lỗi. Ví dụ comment dùng comment out dòng mã:
class FridayMessage {
public static void main(String[] args) {
String day_of_the_week = "Friday";
// System.out.println("It's " ++ day_of_the_week);
}
}
Trong ví dụ, chúng ta comment out dòng bắt đầu System.out.println. Mã trả lỗi (vì dùng ++ hai lần thay vì một) và comment out mã khi tìm nguồn lỗi.
Comment out mã đặc biệt hữu ích khi phân tích logic chương trình. Trong tình huống này, bạn có thể muốn comment out nhiều lần lặp mã cho đến khi tìm cách hiệu quả nhất. Sau đó, xóa mã cũ.
Chỉ nên comment out mã trong giai đoạn kiểm thử và gỡ lỗi. Để comment out mã trong chương trình cuối cùng gây nhầm lẫn cho lập trình viên khác và làm mã khó đọc.
Kết luận
Trong Java, có hai loại comment: comment đơn dòng (inline) và comment nhiều dòng (block). Comment dùng ghi chép mã và hỗ trợ giai đoạn kiểm thử, gỡ lỗi.
Dành thời gian comment mã sẽ làm công việc dễ đọc cho cả bạn và bất kỳ ai đọc mã. Cuối cùng, nhớ comment tốt nhất là giải thích ý định sau mã.
Bây giờ bạn sẵn sàng viết comment trong Java như chuyên gia!