Tôi sử dụng javadoc để ghi lại các lớp và phương pháp của mình. Tôi cũng muốn thêm một số thông tin tổng quan vào các gói của mình. Tôi thích cách Eclipse tạo ra một câu trả lời của Doc Comment phù hợp cho từng lớp hoặc phương thức khi tôi nhập /**<Enter>. Eclipse cũng có cách dễ dàng để tạo ra một package.html file không?Tôi có thể thêm JavaDoc vào một gói dễ dàng với Eclipse không?
Cập nhật 4 năm sau đó (Tháng 10 2013)
javabeangrinder 's answer (upvoted) đề cập đến cách lừa sau:
Để tạo một tập tin
package-info.javatrong một gói phần mềm hiện có:
package-info.java.new->package.Create package.info.java.FinishOriginal câu trả lời (tháng 5 năm 2009)
Không có mẫu hoặc hướng dẫn để dễ dàng tạo ra một file package.html.
Như là mmyers cho biết trong nhận xét của mình, kể từ Java1.5, tệp chính xác để tạo sẽ là package-info.java.
Tệp đó có thể được sử dụng không chỉ cho javadocs, mà còn cho package-level annotations (như illustrated here).
Có một opened Bug (#86168) cho đòi hỏi một thuật sĩ để tạo ra các package-info.java (kể từ wizard lớp không cho phép package-info tên).
Phản ánh về chủ đề đó được bật kể từ ... 2005! Vấn đề là bất kỳ giải pháp nào nên được triển khai theo cách nó cũng giúp với mã số 1.4.
Cách giải quyết hiện tại là tạo package-info.java dưới dạng tệp text.
Từ thời điểm đó trở đi, package-info.java hoạt động như một lớp Java bình thường và Eclipse đặt một tệp package-info.class vào thư mục đầu ra.
Javadocs được xây dựng chính xác bằng cách sử dụng package-info.java và không phải là tệp package.html.
alt text http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png
Note (để đáp ứng với Strawberry 's bình luận):
cả mong muốn một bản xem trước của tổng quan gói trong package-info.java trong giao diện Javadoc .
Cho đến nay, không có bản vá nào được đề xuất/triển khai.
Chỉ đơn giản là không đủ nhu cầu cho tính năng đó được thêm vào.
Có cách nào để tải gói javadocs để hiển thị trong cửa sổ xem nhanh Javadoc - vì chúng làm cho các lớp học, giao diện và phương pháp? – Martin
@Strawberry: không, không có chế độ xem Javadoc cho package-info.java. Xem câu trả lời mở rộng của tôi về điều đó. – VonC
Lưu ý tự, sau [câu hỏi này] (http://stackoverflow.com/a/9600531/6309), tôi đã vượt qua 200K * lần nữa *! (do một số [rep recalc] (http://meta.stackexchange.com/questions/125121/has-reputation-for-deleted-posts-been-removed-again)) – VonC
Có plugin có vẻ như tạo tệp package.html. Tôi đã không sử dụng nó nhưng ai đó hạ cánh ở đây có thể thấy nó hữu ích.
Các JAutodoc Plugin làm một công việc tuyệt vời này, cũng như tất cả các nhu cầu tài liệu khác của bạn. Cài đặt và cấu hình các plugin và kích chuột phải vào gói và nhấp JAutodoc> Add Package Javadoc
Có cấu hình và các mẫu có sẵn cho các tài liệu .java hoặc .html gói.
Plugin này cũng thực hiện tốt công việc chuẩn hóa tất cả nhu cầu Javadoc của bạn, với rất nhiều tùy chỉnh.
Trong nhật thực
Kể từ package-info.java không phải là một định danh hợp lệ cho một lớp nó không thể được tạo ra như là một lớp trong Eclipse.
Tôi thấy rằng khi bạn tạo một gói mới, có một hộp kiểm để kiểm tra xem bạn có muốn gói package-info.java không.
Để tạo một tập tin package-info.java trong một gói phần mềm hiện có:
Haha rất trực quan, cảm ơn :) Nó không trả lời câu hỏi, nhưng nó đã giúp tôi! –
+1. [Theo yêu cầu] (http://stackoverflow.com/questions/893474/can-i-add-javadoc-to-a-package-easily-with-eclipse/14708381#comment28966789_894385) của [Mr_and_Mrs_D] (http://stackoverflow.com/users/281545/mr-and-mrs-d), tôi đã tham chiếu nó trong câu trả lời của tôi ở trên (và upvoted của bạn). – VonC
Trong Kepler, hộp kiểm hiện nói "Tạo gói-info.java". Tin hay không, việc thiếu dấu nối trong bước 3 ở trên làm tôi bối rối một chút. –
Chỉ cần lưu ý: như Java 1.5, vị trí ưa thích cho nhận xét gói là package-info.java, không phải package.html. Bằng cách này, bạn cũng có thể xác định chú thích cấp gói. Xem http://java.sun.com/javase/6/docs/technotes/guides/javadoc/whatsnew-1.5.0.html –