Khi bạn viết mã, điều đầu tiên bạn nghĩ đến là cách máy tính xử lý mã bạn viết. Tuy nhiên, điều cần thiết là phải suy nghĩ về cách mọi người sẽ đọc mã của bạn.
Cho dù bạn đang làm việc trong một dự án với một nhóm hay chỉ đang tự mình xây dựng một thứ gì đó, bạn nên thực hiện các bước để ghi lại mã của mình một cách đầy đủ .. Đó là lúc các nhận xét xuất hiện.
Nhận xét là một dòng hoặc nhiều dòng văn bản được viết trong một chương trình bị máy tính bỏ qua. Nhận xét được sử dụng để giải thích mục đích của một chương trình cho những người có thể đang đọc mã của bạn, cho dù đó là chính bạn hay người khác.
Hướng dẫn này sẽ thảo luận về cách viết bình luận bằng Java và hướng dẫn một số phương pháp hay nhất mà bạn có thể sử dụng để viết bình luận hiệu quả.
Nhận xét Java
Nếu bạn là người mới học lập trình, bạn có thể tự hỏi mình:tại sao bạn phải comment code? Có một số lý do tại sao các chú thích mã lại quan trọng để viết.
Khi bạn đang viết mã, điều quan trọng là phải thừa nhận rằng mã của bạn sẽ được đọc bởi ai đó, ngay cả khi người đó là bạn. Hơn nữa, không có gì đảm bảo rằng người đọc mã của bạn sẽ hiểu mã bạn đã viết.
Nếu bạn đang làm việc một mình, việc có mã mà không có nhận xét có thể khiến bạn cảm thấy bực bội và mất thời gian tìm hiểu cách mã hoạt động. Nhưng nếu bạn đang làm việc trong một nhóm, việc không có nhận xét thậm chí có thể gây khó khăn hơn. Các nhà phát triển khác có thể phải hỏi bạn về mã của bạn, điều này có thể tiêu tốn thời gian quý báu.
Nhìn chung, viết bình luận làm cho mã dễ đọc hơn. Khi bạn đang viết một quy trình phức tạp, có thể hữu ích nếu có một số văn bản thuần túy bên cạnh mã của bạn để giải thích ý định của bạn đằng sau một số dòng mã nhất định. Nhận xét bạn viết sẽ hữu ích để tham khảo trong tương lai, đặc biệt nếu bạn đang làm việc với các nhà phát triển khác trong một dự án.
81% người tham gia cho biết họ cảm thấy tự tin hơn về triển vọng công việc công nghệ của mình sau khi tham gia một cuộc thi đào tạo. Kết hợp với bootcamp ngay hôm nay.
Sinh viên tốt nghiệp bootcamp trung bình dành ít hơn sáu tháng để chuyển đổi nghề nghiệp, từ khi bắt đầu bootcamp đến khi tìm được công việc đầu tiên của họ.
Các nhận xét tốt nhất giải thích mục đích đằng sau mã của bạn. Tại sao bạn làm điều gì đó theo một cách cụ thể, thay vì nhắc lại những gì một dòng mã làm? Nhận xét hiệu quả trả lời các câu hỏi và nâng cao hiệu quả.
Cú pháp nhận xét Java
Trong Java, có hai loại chú thích doc có thể được viết:chú thích một dòng và chú thích nhiều dòng.
Nhận xét một dòng
Nhận xét một dòng, thường được gọi là nhận xét nội dòng, xuất hiện ở cuối dòng mã.
Nhận xét nội tuyến thường được sử dụng để chú thích các phần nhỏ của mã kéo dài một hoặc nhiều dòng.
Giả sử chúng ta đang viết một chương trình in ra thông báo It’s Friday vào bảng điều khiển. Chúng tôi muốn viết một bình luận để theo dõi mã của chúng tôi. Dưới đây là một ví dụ về nhận xét nội dòng mà chúng tôi có thể sử dụng:
public class FridayMessage {
public static void main(String[] args) {
System.out.println("It's Friday!"); // prints "It's Friday" to the console
}
}
Nhận xét nội tuyến chỉ nên được sử dụng khi bạn cần giải thích ý định của mình đằng sau một dòng mã cụ thể. Mã bao gồm một số lượng lớn các bình luận nội tuyến có thể nhanh chóng trở nên khó đọc.
Điều quan trọng cần lưu ý là khi bạn viết nhận xét, mục tiêu của bạn phải là giải thích ý định đằng sau nhận xét của bạn. Trong ví dụ trên của chúng tôi, nhận xét của chúng tôi không hữu ích lắm vì rất dễ dàng để biết mã của chúng tôi làm gì. Nhưng nếu chúng tôi có một dòng mã phức tạp hơn, có thể cần một nhận xét.
Nhận xét nhiều dòng
Nhận xét nhiều dòng, còn được gọi là nhận xét khối, là các nhận xét được sử dụng để giải thích một phần mã. Nhận xét nhiều dòng sẽ kéo dài nhiều dòng và thường được đặt ở đầu tệp hoặc trước khi một khối mã bắt đầu.
Nhận xét nhiều dòng bắt đầu bằng /* và kết thúc bằng */ . Dưới đây là một ví dụ về nhận xét nhiều dòng trong tệp nguồn Java:
/ * Đây là một ví dụ về nhận xét nhiều dòng.
Đoạn mã dưới đây in ra It’s Friday! vào bảng điều khiển.
* /
public class FridayMessage {
public static void main(String[[ args) {
System.out.println("It's Friday!");
}
}
Trong ví dụ này, nhận xét của chúng tôi xuất hiện trên ba dòng đầu tiên của mã của chúng tôi.
Thông thường, các chú thích nhiều dòng sẽ được sử dụng ở đầu tệp để ghi chú chi tiết về chính tệp đó. Ví dụ:nhận xét nhiều dòng có thể bao gồm thông tin về tác giả của tệp, phiên bản của tệp và thông tin tương tự.
Mã nhận xét để kiểm tra
Ngoài việc đóng vai trò như một phương pháp lập tài liệu, các chú thích còn được sử dụng để ngăn không cho mã thực thi trong giai đoạn thử nghiệm và gỡ lỗi của quá trình phát triển phần mềm. Người viết mã gọi đây là commenting out code.
Giả sử bạn đang viết một chương trình đã nêu ra một ngoại lệ. Bạn vẫn chưa chắc chắn điều gì sai và vì vậy bạn muốn nhận xét một phần mã của mình để giúp bạn tìm ra nguồn gốc của vấn đề. Dưới đây là một ví dụ về các nhận xét được sử dụng để nhận xét về một 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ụ này, chúng tôi đã nhận xét dòng mã bắt đầu bằng System.out.println . Mã của chúng tôi trả về lỗi (vì chúng tôi sử dụng hai ++ thay vì một) và chúng tôi đã nhận xét mã trong khi chúng tôi tìm ra nguồn gốc của lỗi.
Nhận xét về mã có thể đặc biệt hữu ích khi bạn đang phân tích logic của một chương trình. Trong những tình huống này, bạn có thể muốn nhận xét nhiều lần lặp lại mã của mình cho đến khi bạn tìm thấy mã hiệu quả nhất. Sau thời điểm đó, bạn có thể xóa mã cũ của mình.
Bạn chỉ nên nhận xét mã trong giai đoạn thử nghiệm và gỡ lỗi. Để lại mã đã nhận xét trong chương trình cuối cùng có thể gây nhầm lẫn cho các nhà phát triển khác và cũng làm cho mã khó đọc hơn.
Kết luận
Trong Java, có hai loại chú thích:chú thích một dòng (hoặc nội dòng) và chú thích nhiều dòng (hoặc khối). Những nhận xét này được sử dụng để ghi lại mã của bạn và cũng có thể được sử dụng để hỗ trợ bạn trong giai đoạn thử nghiệm và gỡ lỗi của quá trình phát triển phần mềm.
Dành thời gian để nhận xét về mã của bạn sẽ làm cho công việc của bạn dễ đọc hơn cho cả chính bạn và bất kỳ ai khác có thể đang đọc mã của bạn. Và cuối cùng, hãy nhớ rằng những nhận xét tốt nhất là những nhận xét giải thích mục đích đằng sau mã của bạn.
Bây giờ bạn đã sẵn sàng để bắt đầu viết nhận xét bằng Java như một người chuyên nghiệp!