ví dụ điển hình của Javadoc [đã đóng]

Có một ví dụ tốt về một tệp nguồn chứa Javadoc ?

Tôi có thể tìm thấy rất nhiều ví dụ hay về Javadoc trên internet, tôi chỉ muốn tìm ra cú pháp cụ thể được sử dụng để tạo chúng và giả sử tôi có thể tìm hiểu thông qua nguồn của một số thư viện ở đâu đó nhưng có vẻ như rất nhiều công việc.

Làm thế nào về mã nguồn JDK, nhưng được truy cập thông qua bên thứ 3 như docjar? Ví dụ: nguồn Bộ sưu tập .

Bằng cách đó, không có tải xuống lớn.

Trang Cách viết tài liệu Coments cho Công cụ Javadoc chứa một số ví dụ hay. Một phần được gọi là Ví dụ về Nhận xét của Doc và chứa khá nhiều cách sử dụng.

Ngoài ra, Câu hỏi thường gặp Javadoc chứa một số ví dụ khác để minh họa các câu trả lời.

Làm thế nào về mã nguồn JDK ?

Tôi sử dụng một tập nhỏ các mẫu tài liệu:

• luôn luôn ghi chép về sự an toàn của luồng
• luôn luôn ghi chép bất biến
• javadoc với các ví dụ (như Formatter )
• @ Phân biệt với TẠI SAO và CÁCH thay thế phần tử chú thích

Hãy xem nguồn khung mùa xuân, nó có javadocs tuyệt vời

Ví dụ ANT - mã nguồn có thể duyệt trực tuyến: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co

Để chọn các tệp khác bắt đầu từ: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

Tải về các nguồn của Lucene và xem cách họ làm điều đó. Họ có JavaDocs tốt.

Nếu bạn đang sử dụng Eclipse , thì bạn có thể thiết lập JDK (không phải JRE ) trong JRE đã cài đặt và sau đó sử dụng Loại mở ( Ctrl+ Shift+ T), đưa ra một cái gì đó nhưjava.util.Collections

Tài liệu về gói và các lớp EventBus của Google Guava là một ví dụ điển hình về Javadoc. Đặc biệt là các tài liệu gói với sự khởi đầu nhanh chóng được viết tốt.

Nếu bạn cài đặt JDK và chọn cài đặt nguồn quá, src.zip chứa nguồn TẤT CẢ các lớp Java công khai. Hầu hết trong số này có javadoc khá tốt.

Nếu tất cả những gì bạn tìm kiếm là cú pháp, thì điều này có thể giúp:

Cách viết nhận xét tài liệu cho công cụ Javadoc