Làm thế nào để tôi tài liệu gói trong Java?

182

Trong các API Java, tôi có thể thấy các bình luận Javadoc cho các gói.

Làm thế nào / nơi tôi đặt các bình luận Javadoc để ghi lại một gói?

java packages javadoc

— jjnguy
nguồn

257

Kể từ 1.5, bạn có thể xác định package-info.javatệp và cung cấp nhận xét kiểu javadoc tiêu chuẩn cho gói:

com / foo / pack-info.java:

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

Đặc tả ngôn ngữ cho các gói

— Gareth Davis
nguồn

3

Liên kết trực tiếp đến spec: docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1

— gavenkoa

7

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 gói này phải nằm trong menu tệp mới

— bsautner

Tôi tìm thấy tệp cần có trong packagename / src / packagename (với phần còn lại của tệp nguồn)

— trindflo

48

Lên đến và bao gồm Java 1.4, bạn phải cung cấp gói tệp HTML.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 một package-info.java, trong đó có một nhận xét Javadoc thông thường (không có HTML). Loại thứ hai được ưa thích, 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: Tài liệu của Sun cho javadoc

— sleske
nguồn

2

+1 để đề cập đến cả hai cách và sự khác biệt cần thiết giữa chúng. Nhân tiện, ít nhất IntelliJ IDEA hiện có hỗ trợ tốt hơn cho gói.html (Ctrl-Q trên tên gói hiển thị gói Javadocs).

— Jonik

3

Cập nhật nhận xét trước đây của tôi: ngày nay IDEA package-info.javachỉ hỗ trợ tốt.

— Jonik

4

Với một package.htmltệp ở cấp gói (tức là trong thư mục cho gói đó). Đây phải là một HTMLtệp được tạo hoàn chỉnh , với <html>thẻ được xác định trong đó

— oxbow_lakes
nguồn

1

Thêm chi tiết? Các tập tin nên trông như thế nào?

— jjnguy

1

Đó là một tệp HTML chứa mô tả gói của bạn. Đó là nó!

— oxbow_lakes

3

Đây là cách cũ để làm điều đó. Từ Java 1.5 trở đi, bạn có thể sử dụng gói

— info.java