contoh yang bagus dari Javadoc [ditutup]

140

apakah ada contoh yang baik dari file sumber yang mengandung Javadoc ?

Saya dapat menemukan banyak contoh Javadoc yang baik di internet, saya hanya ingin mengetahui sintaksis yang digunakan untuk membuatnya, dan menganggap saya dapat menelusuri sumber beberapa perpustakaan di suatu tempat tetapi itu sepertinya banyak pekerjaan.

java javadoc Jason S
sumber

Jawaban:

118

Bagaimana dengan kode sumber JDK, tetapi diakses melalui pihak ke-3 seperti docjar? Misalnya, sumber Koleksi .

Dengan begitu, tidak ada unduhan besar.

GaryF
sumber
1
Itu jawaban yang bagus sejak koleksi di mana ditulis oleh Josh dan Neal.
cherouvim
Perangkat lunak antivirus saya mengatakan bahwa tautan docjar tidak aman. Apakah Anda tahu ada situs web lain yang menampilkan sumber koleksi? (Saya akan membiarkannya meluncur jika ini bukan pertanyaan lalu lintas yang cukup tinggi :)
Gordon Gustafson
2
Jika di windows, instalasi JDK berisi src.zipfile dengan kode sumber perpustakaan standar.
Sri Harsha Chilakapati
Bagaimana legalitas bagi pihak ketiga untuk mendistribusikan kode yang dilindungi hak cipta? Atau apakah hak cipta memungkinkan itu?
ThePyroEagle
Ini adalah masalah utama dengan tautan eksternal, "Docjar.net BAWAH untuk semua orang."
Book Of Zeus
9

Bagaimana dengan kode sumber JDK ?

ayam mentega
sumber
itu adalah pemikiran saya yang jelas tetapi saya harus mengunduh seluruh kekacauan besar ini. :-(
Jason S
5
Kemungkinan Anda sudah memilikinya, karena ia datang dengan JDK (meskipun ini merupakan opsi instalasi).
Michael Borgwardt
5

Saya menggunakan satu set kecil pola dokumentasi:

  • selalu mendokumentasikan tentang keamanan benang
  • selalu mendokumentasikan kekekalan
  • javadoc dengan contoh (seperti Formatter )
  • @Persetujuan dengan MENGAPA dan BAGAIMANA untuk mengganti elemen beranotasi
dfa
sumber
petunjuk bagus untuk memasukkan BAGAIMANA untuk menggantikan yang sudah usang, thx
Tobi Tiggers
4

Lihat sumber kerangka Spring, ia memiliki javadocs yang sangat baik

Gaël Marziou
sumber
2

Unduh sumber-sumber Lucene dan lihat bagaimana mereka melakukannya. Mereka memiliki JavaDocs yang bagus.

RichieHindle
sumber
2

Jika Anda menggunakan Eclipse , maka Anda dapat mengatur JDK Anda (bukan JRE ) di JRE Terinstal , dan kemudian menggunakan Open Type ( Ctrl+ Shift+ T), berikan sesuatu sepertijava.util.Collections

KrishPrabakar
sumber
1
Untuk menambah apa yang dikatakan, sebagian besar IDE secara otomatis mengkonfigurasi javadocs dan sumber ketika Anda mengkonfigurasi JDK untuk mereka gunakan. Ini tidak hanya berlaku untuk Eclipse.
ThePyroEagle
2

Dokumentasi paket dan kelas EventBus Google Guava adalah contoh yang baik dari Javadoc. Terutama dokumentasi paket dengan mulai cepat ditulis dengan baik.

Marvin Frommhold
sumber
1

Jika Anda menginstal JDK dan memilih untuk menginstal sumber juga, src.zip berisi sumber SEMUA kelas publik Java. Sebagian besar memiliki javadoc yang cukup bagus.

Thorbjørn Ravn Andersen
sumber
1

Jika semua yang Anda cari adalah sintaks, maka ini dapat membantu:

Cara Menulis Komentar Doc untuk Alat Javadoc

Jesse
sumber
1
terima kasih, sudah sadar akan hal itu (lihat pertanyaan saya)
Jason S
Jawaban rangkap tanpa memberikan informasi berguna lainnya.
Alexey Ivanov