Chú thích (Comment)

Chú thích (comment) là phần văn bản trong mã nguồn mà trình biên dịch bỏ qua hoàn toàn - dùng để giải thích code cho người đọc.

1. Chú thích một dòng

Dùng //, mọi thứ sau nó trên cùng dòng đều bị bỏ qua:

int age = 20; // Tuổi của người dùng
// Dòng này hoàn toàn là chú thích

2. Chú thích nhiều dòng

Dùng /* ... */, có thể trải dài trên nhiều dòng:

/*
 * Đây là một khối chú thích
 * có thể viết trên nhiều dòng
 */
int score = 100;

⚠️ Chú thích nhiều dòng không thể lồng nhau (/* /* ... */ */ là lỗi cú pháp).

3. Javadoc - chú thích tài liệu

Java có thêm dạng chú thích đặc biệt /** ... */ gọi là Javadoc, dùng để sinh tài liệu API tự động bằng công cụ javadoc. Thường đặt trước class hoặc phương thức:

/**
 * Tính tổng hai số nguyên.
 *
 * @param a số hạng thứ nhất
 * @param b số hạng thứ hai
 * @return tổng của a và b
 */
public static int sum(int a, int b) {
    return a + b;
}

Các thẻ (tag) phổ biến trong Javadoc: @param, @return, @throws, @author, @see.

Tổng kết

• // cho chú thích một dòng
• /* */ cho chú thích nhiều dòng (không lồng được)
• /** */ (Javadoc) dùng để tài liệu hóa class/phương thức, có thể sinh tài liệu HTML tự động bằng công cụ javadoc