Comment trong JAVA

26/11/2019

5156

Các comment không được thực thi bởi các trình biên dịch và trình thông dịch.

Các comment trong Javađược sử dụng để cung cấp thêm thông tin hoặc giải thích về biến, phương thức, class, hoặc bất kỳ câu lệnh nào. Nó cũng có thể được sử dụng để tạm thời vô hiệu hóa một đoạn code nào đó trong Java.

>> Mẹo comment trong Java

3 Kiểu comment trong Java

Trong Java, để comment, chúng ta có 3 cách:

Comment 1 dòng
Comment nhiều dòng
Comment dạng Doc

Ví dụ về Comment 1 dòng trong Java

Comment 1 dòng là comment chỉ vừa đủ trên 1 dòng code.

Cú pháp comment 1 dòng

// Đây là comment 1 dòng

Ví dụ:

public class CommentExample1 {  
public static void main(String[] args) {  
    int i = 10; //Đây là một biến kiểu int
    System.out.println(i);  
}  
}

Kết quả:

Ví dụ comment nhiều dòng trong Java

Comment nhiều dòng là comment trên nhiều dòng. Bạn muốn comment bao nhiêu dòng tùy thích.

Cú pháp comment nhiều dòng

/* 
Đây
là
comment
nhiều
dòng
*/

Ví dụ comment nhiều dòng:

public class CommentExample2 {  
public static void main(String[] args) {  
    /* Khai báo biến
    và in giá trị của nó
    ra màn hình */  
    int i = 10;  
    System.out.println(i);  
}  
}

Kết quả:

Ví dụ comment dạng Doc trong Java

Comment dạng Doc là comment để sử dụng tạo ra Documentation API. Sau đó sử dụng javadoc tool để tạo tài liệu.

Cú pháp comment dạng Doc

/** 
Đây là
comment
dạng Doc 
*/

Ví dụ comment dạng Doc

/** Class Calculator cung cấp phương thức để cộng, trừ 2 số:
<strong>a + b</strong> và <strong>a - b</strong>.*/  
public class Calculator {  
/** Phương thức add() trả về kết quả của: <strong>a + b</strong>.*/
public static int add(int a, int b){return a+b;}  
/** Phương thức sub() trả về kết quả của: <strong>a - b</strong>.*/
public static int sub(int a, int b){return a-b;}  
}

Biên dịch đoạn code trên bằng javac tool:

javac Calculator.java

Tạo tài liệu Documentation API bằng javadoc tool:

javadoc Calculator.java

Bây giờ, sẽ có các tệp HTML được tạo cho class Calculator của bạn trong thư mục hiện tại.

Bạn có thể mở các tệp HTML và xem giải thích về class Calculator thông qua comment dạng Doc

Lưu ý: Vì javadoc tool biên dịch các comment sang dạng HTML nên bạn có thể sử dụng các thẻ HTML để tạo ra tài liệu sinh động hơn.

Vô hiệu hóa code bằng comment trong Java

Chúng ta có thể ngăn trình biên dịch thực thi đoạn code nào đó bằng cách đặt nó vào trong comment như thế này:

public class CommentExample2 {  
public static void main(String[] args) {  
    /* Khai báo biến
    và in giá trị của nó
    ra màn hình */

    //int i = 10;
    System.out.println(i);

    /*
    int a = 20;
    System.out.println(a);
    */

    int b = 30;
    System.out.println(b);
}  
}

Kết quả nhận được là:

Bạn đã hiểu về Comment trong Java chưa?

Comment rất quan trọng lập trình nói chung và lập trình Java nói riêng.

Đoạn code của bạn sẽ nhanh chóng khó hiểu, vì thế, để giúp cho bạn và người trong team của bạn có thể đọc hiểu đoạn code bạn viết là gì thì hãy viết comment cẩn thận.

Đây là điều rất cần thiết khi đi làm lập trình tại các doanh nghiệp phần mềm