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
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