Bài 7. Hướng Dẫn Cách Ghi Chú Trong Java | Tự Học Java Căn Bản

Ghi chú trong Java là gì?

Ghi chú (comment) trong Java là các đoạn mã giúp lập trình viên giải thích code nhưng không ảnh hưởng đến quá trình biên dịch và thực thi. Việc sử dụng comment đúng cách giúp code dễ hiểu hơn, hỗ trợ làm tài liệu và bảo trì chương trình dễ dàng.

Các loại ghi chú trong Java

Java hỗ trợ ba loại ghi chú chính:

1. Ghi chú một dòng (//)
2. Ghi chú nhiều dòng (/* ... */)
3. Ghi chú tài liệu Javadoc (/** ... */)

Ghi chú một dòng

Ghi chú một dòng trong Java bắt đầu bằng // và chỉ áp dụng cho phần còn lại của dòng đó. Java sẽ bỏ qua nội dung sau // khi biên dịch.

Ví dụ:

public class Main {
    public static void main(String[] args) {
        // In ra dòng chữ "Hello, Java!"
        System.out.println("Hello, Java!"); // Đây cũng là một chú thích
    }
}

Khi nào sử dụng ghi chú một dòng?

• Ghi chú nhanh cho một dòng mã cụ thể.
• Tạm thời vô hiệu hóa một dòng code mà không xóa nó.

Ghi chú nhiều dòng

Ghi chú nhiều dòng trong Java bắt đầu bằng /* và kết thúc bằng */. Loại này có thể trải dài trên nhiều dòng.

Ví dụ:

public class Main {
    public static void main(String[] args) {
        /*
         * Đây là một chú thích nhiều dòng.
         * Nó có thể trải dài trên nhiều dòng.
         * Thường được dùng để giải thích đoạn mã phức tạp.
         */
        System.out.println("Hello, Java!");
    }
}

Khi nào sử dụng ghi chú nhiều dòng?

• Ghi chú chi tiết về một đoạn code quan trọng.
• Vô hiệu hóa nhiều dòng code một cách nhanh chóng.

Ghi chú tài liệu Javadoc

Javadoc là một loại ghi chú đặc biệt trong Java, bắt đầu bằng /** và kết thúc bằng */. Nó được dùng để tạo tài liệu API cho class, method, hoặc biến.

Ví dụ:

/**
 * Lớp Calculator thực hiện các phép toán cơ bản.
 */
public class Calculator {

    /**
     * Phép cộng hai số.
     *
     * @param a Số thứ nhất
     * @param b Số thứ hai
     * @return Tổng của a và b
     */
    public int add(int a, int b) {
        return a + b;
    }
}

Khi nào sử dụng Javadoc?

• Khi cần tạo tài liệu cho mã nguồn Java.
• Khi viết thư viện hoặc API để người khác sử dụng.

Bạn có thể tạo tài liệu HTML từ Javadoc bằng cách sử dụng lệnh sau:

javadoc -d docs MyClass.java

Hoặc trong Eclipse, chọn Project > Generate Javadoc để tự động tạo tài liệu.

Các thẻ quan trọng trong Javadoc

Javadoc hỗ trợ nhiều thẻ đặc biệt giúp tài liệu hóa mã nguồn một cách chi tiết hơn.

Ví dụ sử dụng nhiều thẻ Javadoc:

/**
 * Lớp MathUtils chứa các phương thức toán học tiện ích.
 * @author John Doe
 * @version 1.0
 */
public class MathUtils {

    /**
     * Tính giai thừa của một số nguyên dương.
     *
     * @param n Số nguyên dương
     * @return Giai thừa của n
     * @throws IllegalArgumentException nếu n < 0
     */
    public static int factorial(int n) {
        if (n < 0) {
            throw new IllegalArgumentException("n phải >= 0");
        }
        int result = 1;
        for (int i = 1; i <= n; i++) {
            result *= i;
        }
        return result;
    }
}

Kết Luận

• Ghi chú giúp code dễ hiểu hơn, đặc biệt khi làm việc nhóm.
• Sử dụng đúng loại ghi chú phù hợp với mục đích:
  • // cho ghi chú ngắn.
  • /* ... */ cho ghi chú dài hoặc vô hiệu hóa nhiều dòng.
  • /** ... */ để tạo tài liệu API với Javadoc.
• Không lạm dụng ghi chú. Chỉ ghi chú khi thực sự cần thiết để tránh làm rối code.

Bài tiếp theo: Bài 8. Cách kiểm tra và xử lý lỗi biên dịch trong Java