2009-07-03 53 views
122

có ví dụ hay về tệp nguồn chứa Javadoc?ví dụ hay về Javadoc

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

Trả lời

102

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

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

+1

Đó là một câu trả lời hay vì các bộ sưu tập được viết bởi Josh và Neal – cherouvim

+0

Phần mềm chống vi-rút của tôi nói rằng liên kết docjar không an toàn. Bạn có biết bất kỳ trang web nào khác có nguồn tập hợp không? (Tôi sẽ để nó trượt nếu đây không phải là câu hỏi có lưu lượng truy cập cao) –

+2

Nếu trên cửa sổ, cài đặt JDK chứa tệp 'src.zip' với nguồn Mã số của các thư viện chuẩn –

8

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

+0

đó là suy nghĩ rõ ràng của tôi nhưng tôi phải tải xuống toàn bộ mớ hỗn độn lớn. :-( –

+4

Có thể bạn đã có nó, vì nó đi kèm với JDK (mặc dù đó là một tùy chọn cài đặt) –

1

Tải xuống nguồn của Lucene và xem cách chúng thực hiện. Họ có JavaDocs tốt.

4

tôi sử dụng một tập hợp nhỏ của các mô hình tài liệu:

  • luôn ghi lại về thread-an toàn
  • luôn ghi lại bất biến
  • javadoc với các ví dụ (như Formatter)
  • @Deprecation với lý do và cách để thay thế phần tử được chú thích
0

Nếu tất cả các bạn đang tìm kiếm là cú pháp, thì đây có thể giúp:

How to Write Doc Comments for the Javadoc Tool

+1

cảm ơn, đã nhận thức được điều đó mặc dù (xem câu hỏi của tôi) –

+0

Câu trả lời trùng lặp mà không cung cấp cho chúng tôi thông tin eful. –

1

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

3

Có một cái nhìn tại nguồn Spring framework, nó có javadocs tuyệt vời

+9

Đó là điều tốt nhất mà bất cứ ai từng nói về mùa xuân. – Pedantic

2

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

+1

Để thêm vào những gì đã nói, hầu hết các IDE sẽ tự động định cấu hình javadocs và nguồn khi bạn định cấu hình JDK cho chúng để sử dụng. Điều này không chỉ áp dụng cho Eclipse. – ThePyroEagle

1

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