Nhận xét Java là các ghi chú trong tệp mã Java bị trình biên dịch và công cụ thời gian chạy bỏ qua. Chúng được sử dụng để chú thích mã nhằm làm rõ thiết kế và mục đích của nó. Bạn có thể thêm số lượng bình luận không giới hạn vào một tệp Java, nhưng có một số “phương pháp hay nhất” để tuân theo khi sử dụng bình luận.
Nhận xét mã nói chung là nhận xét “triển khai” giải thích mã nguồn , chẳng hạn như mô tả về lớp, giao diện, phương thức và trường. Đây thường là một vài dòng được viết bên trên hoặc bên cạnh mã Java để làm rõ những gì nó làm.
Một loại chú thích Java khác là chú thích Javadoc. Chú thích Javadoc hơi khác về cú pháp so với chú thích triển khai và được chương trình javadoc.exe sử dụng để tạo tài liệu Java HTML.
Tại sao lại sử dụng bình luận Java?
Bạn nên tập thói quen đưa các nhận xét Java vào mã nguồn của mình để cải thiện tính dễ đọc và rõ ràng cho bạn và các lập trình viên khác. Không phải lúc nào cũng rõ ràng ngay lập tức một phần của mã Java đang làm gì. Một vài dòng giải thích có thể giảm đáng kể lượng thời gian cần thiết để hiểu mã của bạn.
Chúng có ảnh hưởng đến hoạt động của chương trình không?
Nhận xét triển khai trong mã Java chỉ dành cho con người đọc. Trình biên dịch Java không quan tâm đến chúng và khi biên dịch chương trình , họ chỉ cần bỏ qua chúng. Kích thước và hiệu quả của chương trình đã biên dịch của bạn sẽ không bị ảnh hưởng bởi số lượng nhận xét trong mã nguồn của bạn.
Nhận xét thực hiện
Nhận xét triển khai có hai định dạng khác nhau:
- Nhận xét theo dòng: Đối với nhận xét một dòng, hãy nhập “//” và làm theo hai dấu gạch chéo về phía trước với nhận xét của bạn. Ví dụ:
// đây là chú thích một dòng
int GuessNumber = (int) (Math.random() * 10);Khi trình biên dịch gặp hai dấu gạch chéo về phía trước, nó biết rằng bất kỳ thứ gì ở bên phải của chúng sẽ được coi là nhận xét. Điều này rất hữu ích khi gỡ lỗi một đoạn mã. Chỉ cần thêm nhận xét vào dòng mã bạn đang gỡ lỗi và trình biên dịch sẽ không nhìn thấy nhận xét đó:
-
// đây là chú thích một dòng
// int GuessNumber = (int) (Math.random() * 10);Bạn cũng có thể sử dụng hai dấu gạch chéo lên phía trước để đưa ra nhận xét cuối dòng:
-
// đây là chú thích một dòng
int GuessNumber = (int) (Math.random() * 10); // Một chú thích ở cuối dòng
-
- Chặn bình luận – Để bắt đầu bình luận khối, hãy nhập “/*”. Mọi thứ nằm giữa dấu gạch chéo lên và dấu hoa thị, ngay cả khi nó nằm trên một dòng khác, đều được coi là một nhận xét cho đến khi các ký tự “*/” kết thúc nhận xét. Ví dụ:
/* đây
là
một block comment */ /* cũng vậy */
Nhận xét Javadoc
Sử dụng các nhận xét Javadoc đặc biệt để ghi lại API Java của bạn. Javadoc là một công cụ đi kèm với JDK để tạo tài liệu HTML từ các nhận xét trong mã nguồn.
Một nhận xét Javadoc về
.Java
các tệp nguồn được bao gồm trong cú pháp bắt đầu và kết thúc như sau:
/**
Và
*/
. Mỗi nhận xét trong số này được đặt trước bởi một
*Đặt các nhận xét này ngay phía trên phương thức, lớp, hàm tạo hoặc bất kỳ phần tử Java nào khác mà bạn muốn ghi lại. Ví dụ:
// myClass.java
/**
* Biến câu này thành một câu tóm tắt mô tả lớp học của bạn.
* Đây là một dòng khác.
*/ lớp
công khai myClass { ... }
Javadoc kết hợp một số thẻ kiểm soát cách tạo tài liệu. Ví dụ, anh ấy
@param/** phương thức chính
* @param args String[]
*/
public static void main(String[] args)
{
System.out.println("Xin chào thế giới!");
}
Nhiều thẻ khác có sẵn trong Javadoc và nó cũng hỗ trợ các thẻ HTML để giúp kiểm soát đầu ra. Xem tài liệu Java để biết thêm chi tiết.
Mẹo sử dụng nhận xét
- Đừng quá bình luận. Không cần thiết phải giải thích mọi dòng trong chương trình của bạn. Nếu chương trình của bạn trôi chảy một cách logic và không có gì bất ngờ xảy ra, bạn không cần phải thêm nhận xét.
- Thụt lề nhận xét của bạn. Nếu dòng mã bạn đang nhận xét bị thụt lề, hãy đảm bảo rằng nhận xét của bạn khớp với phần thụt lề.
- Giữ bình luận có liên quan. Một số lập trình viên rất giỏi trong việc sửa đổi mã, nhưng vì lý do nào đó họ lại quên cập nhật nhận xét. Nếu một bình luận không còn áp dụng, sửa đổi hoặc xóa nó.
- Không lồng các bình luận khối. Sau đây sẽ dẫn đến lỗi trình biên dịch:
/* đây
là
/* Bình luận khối này kết thúc bình luận đầu tiên */
bình luận
khối */
