Cách generate Javadoc trong Eclipse

Trong lập trình Java, chúng ta có thể sử dụng javadoc tool để generate ra các API documentation từ các comment được nhúng trực tiếp trong code. Tuy nhiên, nó đòi hỏi chúng ta phải nhớ rất nhiều option của công cụ này, điều này gây khó khăn và tốn thời gian.

Eclipse có thể giúp bạn thực thi công việc tương tự mà không tốn qúa nhiều thời gian cũng như phải ghi nhớ các option của javadoc tool.

Giả sử chúng ta có một đoạn mã nguồn Java như sau:

/**
 * Connects and logins to the FTP server.
 *
 * @throws FTPConnectionException If an I/O error occurs.
 * @throws FTPLoginException If the login operation did not succeed.
 */
public void login() throws FTPConnectionException, FTPLoginException {
 
    // method body
 
}

Chúng ta có thể thấy method login() chứa một số comment bắt đầu bằng /** và kết thúc bằng */. Chúng ta có thể generate chúng ta dạng documentation dưới dạng HTML trong giống như hình này

Để đạt được điều này, trong Eclipse, chọn Generate Javadoc từ Project menu, hộp thoại sẽ mở ra.

Trong hộp thoại trên, chúng ta sẽ làm theo các bước được đánh số thứ tự như trên hình.

Chỉ định javadoc.exe tool trên máy của bạn. Thông thường nó nằm ở thư mục JAVA_HOME.
Chọn project và các package bạn muốn generate Javadoc.
Lựa chọn các file Java sẽ được generate ra Javadoc, mặc định tất cả các file sẽ được chọn.
Giới hạn các class có access modifier tương ứng sẽ được generate javadoc.
Chỉ định thư mục lưu trữ Javadoc được sinh ra.
Chọn Next.

Trong màn hình tiếp theo, chúng ta sẽ có một số tham số và option trong javadoc tool.

Như:

Document title
Document structure
Documenting tags
Các JAR file và project liên kết
Stylesheet

Các bạn chỉ cần chỉnh sửa Document title là được, những tuỳ chọn khác cử để mặc định.

Màn hình tiếp theo chúng ta cũng có một số option overview document (1); VM options (2); Extra javadoc options (3):

Nếu bạn muốn tái sử dụng cấu hình cho các lần export tiếp theo, chọn “Save the settings of this Javadoc export as an Ant script” (4) và chỉ định vị trí lưu trữ Ant build file.

Nếu tùy chọn “Open generated index file in browser (5) được chọn, thì Eclipse sẽ mở tài liệu được tạo trong trình duyệt web nội bộ của nó.

Chọn Finish. Chúng ta sẽ có một Javadoc như ví dụ sau