Tạo Comment và Documentation trong Java

A. Comment trong java
Có các loại ghi chú sau:
1. /* ghi chú của bạn */
2. // Ghi chú của bạn
3. /** Ghi chú của bạn */

Cách thứ 1 và thứ 2 có nguồn gốc từ ngôn ngữ C/C++.
Cách thứ 1 dùng khi cần ghi chú trên nhiều dòng:
Ví dụ: /* Đoạn văn này là phần ghi chú được chia ra làm nhiều dòng */

Cách thứ 2 ghi chú cho từng dòng lệnh, từ dấu // trở về cuối dòng là đoạn ghi chú:
Ví dụ: public string s; // phần ghi chú cho dòng lệnh này

Cách thứ 3 là cách ghi chú mới chỉ dùng trong java. Nó giúp cho việc sưu liệu hóa chương trình (program documentation) của trình biên soạn tài liệu JavaDoc.
Chú ý: Ta không thể dùng tính xếp lồng (nest comment) để trình bày các ghi chú. Nếu trong cặp /* và */ có dùng ký hiệu // thì ý nghĩa của // bị bỏ qua, điều ngược lại cũng đúng.

B. Documentation trong java
Sử dụng cách thứ 3 trong comment để tạo Documentation cho phương thức và lớp.

Demo:

/**
* Hàm này dùng để xuất *
* @param n : nhập vào từ bàn phím
*/

public static void printWildcard1(int n)

{
       for(int i=n;i>0;i–)
       {
          for(int j=i;j>0;j–)
            System.out.print(“*”);
       }

       System.out.println();
}

Ngay dòng đầu tiên của comment bạn để ý là /** Nhớ là có 2 dấu * ngay đằng sau dấu /.