Tôi làm cách nào để tạo một cái lọ có thể phân phối cho javadocs?

Question

Tôi đã tạo một API mà tôi phát hành dưới dạng tệp JAR. Đó là độc quyền vì vậy tôi đã phải tách các tập tin nguồn ra khỏi nó.

Tôi hiện bao gồm một thư mục riêng/doc chứa đầu ra của thuật sĩ xuất chuyển sang javadoc của Eclipse. Không tệ, nhưng tôi muốn đi thêm một bước nữa.

Tôi muốn phân phối tệp javadocs dưới dạng tệp jar có thể dễ dàng bị bỏ vào một dự án trong tương lai bao gồm tệp jar cho API của tôi. Tôi biết tôi đã nhìn thấy nó được thực hiện theo cách này nhiều lần với các bản phân phối khác tôi đã sử dụng, nhưng tôi đã không có bất kỳ may mắn tìm kiếm.

Mục tiêu cuối cùng là cho phép các nhà phát triển trong tương lai dễ dàng truy cập để di chuột qua các nhận xét và những điều có tính chất đó.

Cảm ơn!

Answer 1

Có vẻ như là đủ để đóng gói thư mục doc chứa tài liệu được tạo nhật thực dưới dạng tệp jar. Sau đó, nếu bạn muốn sử dụng jar đó làm javadocs của jar thực có chứa các tệp .class đã biên dịch, bạn gán jar javadoc với "Javadoc in archive" trong Eclipse và đặt đường dẫn trong kho lưu trữ là doc. Có vẻ như Eclipse tìm kiếm các mục nhập index.html và danh sách gói trong thư mục tài liệu.

Cũng sử dụng plugin maven-javadoc có thể là cách dễ dàng để thực hiện việc này. Xem các liên kết dưới đây:

http://www.avajava.com/tutorials/lessons/how-do-i-generate-and-deploy-a-javadoc-jar-file-for-my-project.html

Answer 2

Nếu mục tiêu cuối cùng của bạn là chỉ dành riêng cho các nhà phát triển trong tương lai để có thể xem hướng dẫn javadoc của bạn khi họ đang sử dụng các lớp học hoặc các phương pháp của bạn, trong Eclipse bạn có thể có tùy chọn để xuất khẩu java file nguồn khi bạn xuất thư viện jar của bạn như thể hiện trong hình dưới đây:

này cũng cho phép các nhà phát triển để bước vào và xem mã của bạn trong khi gỡ lỗi.