Viết JavaDocs cho thư viện bên ngoài

Question

Tình huống của tôi là tôi có một thư viện được biên dịch bên ngoài (jar) từ một bên thứ ba không có JavaDocs. Khi tôi đang phát triển, tôi muốn ghi lại các lớp và phương pháp bằng cách kiểm tra và sử dụng tài liệu rất hạn chế mà tôi nhận được từ trang web của bên thứ ba.

Mục tiêu cuối cùng của tôi là có tài liệu JavaDoc mà tôi sẽ có thể sử dụng trong IntelliJ để tra cứu mã và tra cứu tài liệu?

Vì vậy, câu hỏi của tôi là, có thể viết JavaDocs vào một tệp jar đã biên dịch mà tôi có thể nhập không? Có lẽ sử dụng một công cụ hỗ trợ điều này.

Answer 1

Vâng. Tất cả những gì bạn phải làm là viết ra lớp và giao diện và phương thức và định nghĩa biến, mà không cần bất kỳ mã nào, như thể tất cả các phương thức đều trừu tượng và sau đó viết chú thích Javadoc cho chúng. Đây thực sự là cách Sun tạo ra Javadoc, thông qua một cây nguồn hoàn toàn riêng biệt được kiểm soát bởi các nhà văn và biên tập viên kỹ thuật (hi Doug!), Với một quá trình hợp nhất muộn trong quá trình xây dựng để phát hành mã nguồn.