Tôi đang sử dụng Check-Style, FindBugs và PMD để xác thực mã Java của mình. Tôi đã sửa hầu như tất cả các lỗi được các công cụ này phát hiện.Cách thêm nhận xét cấp gói trong Javadoc?
Tôi không thể hiểu cách viết "nhận xét gói" là lỗi được đánh dấu bằng kiểu kiểm tra. Tôi đã trải qua các tài liệu của Check-Style, nhưng tôi không hiểu nó.
Ai đó có thể giúp tôi bằng văn bản nhận xét mức gói trong Java không?
Bạn phải tạo một trang package.html nằm trong gói. Bạn có thể đọc về nội dung và cấu trúc của tệp này trên How to Write Doc Comments for the Javadoc Tool page.
Bằng cách sử dụng tệp package.html cho nhận xét của bạn. Vui lòng xem tài liệu này: How to Write Doc Comments for the Javadoc Tool.
package-info.java trong gói của bạn để ghi lạiSau đây liên kết cung cấp thêm thông tin: http://docs.oracle.com/javase/specs/jls/se5.0/html/packages.html
Chúng tôi khuyên rằng gói -info.java, nếu nó hiện diện, chiếm chỗ của package.html cho javadoc và các hệ thống thế hệ tài liệu tương tự khác
Gói chú thích rộng cũng sẽ được công bố tại package-info.java
Greetz, GHad
Tôi chưa bao giờ nghe nói về phương pháp này trước đây. Bạn có thể cung cấp liên kết tới tài liệu mô tả nó không? –
@Thomas Owens http://java.sun.com/docs/books/jls/third_edition/html/packages.html – emory
Tạo liên kết: Chúng tôi khuyên rằng package-info.java, nếu có, hãy thay thế của package.html cho javadoc và các hệ thống tạo tài liệu tương tự khác. – GHad
Google tìm thấy này là hit đầu tiên:
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#packagecomments
Bạn chỉ cần tạo một tệp có tên package.html trong mỗi gói.
Nhận xét javadoc cấp gói được đặt trong tệp có tên package-info.java bên trong thư mục gói. Nó chứa các bình luận và tuyên bố gói:
/**
* Provides the classes necessary to create an applet and the classes an applet uses
* to communicate with its applet context.
* <p>
* The applet framework involves two entities:
* the applet and the applet context. An applet is an embeddable window (see the
* {@link java.awt.Panel} class) with a few extra methods that the applet context
* can use to initialize, start, and stop the applet.
*
* @since 1.0
* @see java.awt
*/
package java.lang.applet;
Đây là tài liệu ở đây: Package Comment Files
Thú vị. Các trang về viết bình luận cho Javadoc (xem câu trả lời của tôi) thậm chí không đề cập đến điều này. –
@Thomas: việc giữ tài liệu chồng chéo luôn được cập nhật là một bitch. –
Thật vậy. Tôi đã nghi ngờ rằng Sun (và bây giờ là Oracle) sẽ làm tốt hơn với việc duy trì tài liệu. Đặc biệt là kể từ khi tôi đã làm phát triển Java trong hơn 5 năm nay và chưa bao giờ nhìn thấy hoặc nghe nói về phương pháp này để tạo ra tài liệu cấp gói trước đó. –
Bạn có thể thêm tài liệu ở mức gói.
thường package-info.java chỉ chứa một tuyên bố gói, trước ngay lập tức bởi các chú thích trên bao bì. Trong khi tệp có thể chứa mã nguồn cho một hoặc nhiều lớp riêng tư, nó sẽ có dạng rất tệ.
Đề xuất rằng package-info.java, nếu có, hãy thay thế package.html cho javadoc và các hệ thống tạo tài liệu tương tự khác.Nếu tệp này có mặt, công cụ tạo tài liệu nên tìm chú thích tài liệu gói ngay trước khai báo gói (có thể được chú thích) trong package-info.java. Theo cách này, package-info.java trở thành kho lưu trữ duy nhất cho các chú thích và tài liệu ở mức gói. Nếu, trong tương lai, nó sẽ trở thành mong muốn để thêm bất kỳ thông tin cấp gói khác, tập tin này sẽ chứng minh một ngôi nhà thuận tiện cho thông tin này.
Có hai cách để thêm tài liệu hướng dẫn mức khoán sử dụng javadoc:
Thông tin chi tiết và ví dụ là here. Phương thức nào để sử dụng: Javadoc: package.html or package-info.java
Tại sao bỏ phiếu xuống? –
Tôi cho rằng điều này là do không đề cập đến package-info.java chút nào (đó là biến thể ưa thích hiện nay). –