Làm cách nào để tạo các tệp Javadoc HTML trong Eclipse?


165

Tôi đã viết các bình luận kiểu Javadoc như thế này trong mã dự án của tôi:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

Làm cách nào tôi có thể tạo các tệp Javadoc HTML bằng IDE Eclipse?


Câu trả lời:


234
  1. Project> Generate Javadoc....

  2. Trong Javadoc command:trường, duyệt để tìm javadoc.exe (thường là tại [path_to_jdk_directory] \ bin \ javadoc.exe ).

  3. Chọn hộp bên cạnh dự án / gói / tệp mà bạn đang tạo Javadoc.

  4. Trong Destination:trường, duyệt để tìm đích mong muốn (ví dụ: thư mục gốc của dự án hiện tại).

  5. Nhấn vào đây Finish.

Bây giờ bạn có thể tìm thấy Javadoc mới được tạo trong thư mục đích. Mở index.html .


1
Có phải cài đặt JDK Java không? Tôi đã cài đặt Java và có thể tạo các chương trình Java trong Eclipse ... nhưng javadoc.exekhông tồn tại ở bất kỳ đâu trên ổ đĩa của tôi!
AlainD

Cũ, nhưng với bất kỳ ai trong tương lai có thể nhầm lẫn về điều này, hãy kiểm tra xem liệu bạn đã cài đặt JDK trái ngược với JRE chưa (không chứa javadoc.exe ở vị trí này).
omoshiroiii

9

Đây là câu trả lời bổ sung liên quan đến OP:

Một giải pháp dễ dàng và đáng tin cậy để thêm các nhận xét Javadocs trong Eclipse:

  1. Đi đến Help> Eclipse Marketplace....
  2. Tìm "JAutodoc".
  3. Cài đặt nó và khởi động lại Eclipse.

Để sử dụng công cụ này, nhấp chuột phải vào lớp và nhấp vào JAutodoc.


7
AFAIK, JAutodoc không tạo HTML từ các bình luận javadoc hiện có (đó là những gì câu hỏi yêu cầu), mà giúp tạo ra các bình luận javadoc.
Amani Kilumanga

3
Câu trả lời không liên quan đến câu hỏi, nhưng đây là những gì tôi đã tìm kiếm chính xác :)
keya

Eclipse sẽ cho phép bạn tạo Javadocs: Project -> Tạo Javadocs ...
pongapundit

Điều này sẽ chỉ tạo javadoc chứ không phải html, đó là câu hỏi gì.
Ashish

5

Bạn cũng có thể làm điều đó từ dòng lệnh dễ dàng hơn nhiều.

  1. Mở dòng lệnh từ thư mục / gói.
  2. Từ dòng lệnh chạy:

    javadoc YourClassName.java

  3. Để tạo tài liệu hàng loạt cho nhiều Lớp:

    javadoc * .java


2

Để nhanh chóng thêm Javadoc, hãy sử dụng phím tắt sau:

Windows : alt+ shift+J

Mac : + Alt+J

Tùy thuộc vào bối cảnh được chọn, một Javadoc sẽ được in. Để tạo Javadoc được viết bởi OP, chọn phương thức tương ứng và nhấn các phím shotcut.

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.