151
Trong các API Java, tôi có thể xem các chú thích Javadoc cho các gói.Tôi làm cách nào để gói tài liệu bằng Java?
Tôi làm cách nào để đặt chú thích Javadoc vào tài liệu cho gói?
A
Trả lời
214
Tính đến 1.5, bạn có thể xác định một tập tin package-info.java và cung cấp một lời nhận xét kiểu javadoc tiêu chuẩn cho một gói:
com/foo/package-info.java:
/**
* com.foo is a group of bar utils for operating on foo things.
*/
package com.foo;
//rest of the file is empty
3
Với tệp package.html ở cấp gói (ví dụ: trong thư mục cho gói đó). Tệp này phải là tệp HTML được định dạng đầy đủ, với thẻ <html> được xác định trong đó
38
Cho đến Java 1.4, bạn phải cung cấp tệp HTML package.html, như được mô tả trong các câu trả lời khác.
Vì Java 1.5 bạn cũng có thể cung cấp package-info.java, chứa chú thích Javadoc thông thường (không có HTML). Sau này được ưu tiên, vì nó cung cấp cho bạn một số tính năng bổ sung (đáng chú ý là chú thích gói).
chi tiết: Sun's docs for javadoc
Các vấn đề liên quan
- 1. Làm cách nào để đọc tài liệu java?
- 2. Làm cách nào để ghi lại phương pháp của tôi trong Java như tài liệu Java?
- 3. làm thế nào để tài liệu một gói python
- 4. Làm cách nào để tải tài liệu lên SharePoint bằng Java?
- 5. Làm cách nào để chuyển các tệp tài nguyên bằng Thư viện tĩnh (Cách bọc tài nguyên trong gói)?
- 6. Cách tìm thư mục "Tài liệu của tôi" trong Java
- 7. Làm thế nào để tạo ra một tài liệu html từ đầu bằng cách sử dụng gói HtmlAgility
- 8. Làm cách nào bạn có thể chỉnh sửa tài liệu từ bằng Java
- 9. Làm cách nào để biên dịch các gói trong java?
- 10. Làm cách nào để tham chiếu tài nguyên trong Java?
- 11. Làm cách nào để chuyển đổi Tài liệu Jsoup sang Tài liệu W3C?
- 12. java tài liệu
- 13. Làm cách nào để xóa nhiều tài liệu trong CouchDB?
- 14. Bạn viết tài liệu gói của mình như thế nào?
- 15. Làm cách nào để tìm thư mục 'Tài liệu' của người dùng bằng Java trong OS X?
- 16. Tôi làm cách nào để yêu cầu Windows in tài liệu?
- 17. Cách tốt nhất để thêm gói NuGet làm tài liệu tham khảo dự án trong VS2012?
- 18. Làm cách nào để tôi cài đặt Tài liệu Java cho api ổ google cho android trong Eclipse
- 19. Làm cách nào để đóng gói tệp bằng hộp Vagrant?
- 20. Tôi làm cách nào để gửi cập nhật các gói?
- 21. Tôi làm cách nào để tìm gói của mình?
- 22. Làm cách nào để có được tài liệu thiết kế?
- 23. Làm cách nào để định dạng mã Java trong tài liệu word
- 24. Làm cách nào để xác thực tài liệu đối với các lược đồ Schematron trong Java?
- 25. Android: Tôi làm cách nào để đưa Âm thanh thông báo bằng Tài nguyên âm thanh?
- 26. Làm cách nào để cài đặt các gói trong thư mục $ HOME của tôi bằng pip?
- 27. Tôi làm cách nào để xây dựng gói SharePoint 2010 bằng dòng lệnh?
- 28. Tôi làm cách nào để JTIdy tạo tài liệu HTML được định dạng đúng?
- 29. Làm cách nào để tích hợp tài liệu Google Tài liệu trong Liferay?
- 30. Làm cách nào để truy cập Kinect bằng Java?
Liên kết trực tiếp đến thông số: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 – gavenkoa
trong intellij bạn có thể nhấp chuột phải vào một gói và tùy chọn để tạo điều này phải nằm trong menu tệp mới – bsautner