@param
Tag @param dapat mengarsipkan parameter tunggal dari suatu metode atau konstruktor, atau jenis parameter dari kelas arsip, antarmuka, dan metode generik. Saat menggunakan tag @param, kita harus menggunakan salah satu tag untuk setiap parameter metode. Kata pertama di setiap paragraf akan dianggap sebagai nama parameter, sedangkan sisanya akan dianggap sebagai deskripsi:
@param max jumlah kata -kata maksimum untuk dibaca.
Saat mengarsipkan parameter tipe, kita harus menambahkan <wrap> ke kedua sisi nama parameter tipe:
@param 体中国中国中国中国
Namun, parameter tipe biasanya tidak memerlukan dokumentasi eksplisit, karena semuanya sangat jelas.
@ melihat
Tag @see dapat membuat referensi silang yang ditautkan ke dokumen Javadoc lainnya. Kami dapat memberi nama pengidentifikasi setelah tag, meskipun kami harus memenuhi syarat sepenuhnya. Misalnya, biasanya dapat dinamai dengan nama sederhana anggota kelas, tetapi jika anggota adalah metode yang kelebihan beban, kita harus menentukan versi yang kelebihan beban dari metode dengan menyebutkan jenis setiap parameter. Kami dapat menggunakan nama yang tidak memenuhi syarat untuk menentukan antarmuka atau kelas dalam paket saat ini, tetapi kami harus menggunakan nama yang sepenuhnya memenuhi syarat untuk menentukan jenis dalam paket lain. Kami dapat menentukan anggota dari jenis dengan menggunakan # sebelum nama anggota. Berikut semua valid @ lihat format tag:
Lee #getname @see attr @See com.magic.attr.attr @see com.magic.attr.deck#deck-size @see com.magic.attr.attr#getname @see com.attr.attr.attr#attr (string) @see com.magic.attr.attr.attr.attr#attr (string) @see com.magic.attr.attr.attr.attr#attr (string) @see com.magic.attr.attr.attr.attr#attr (string) @see com.magic.attr.attr.attr.attr. Objek) @see com.magic.attr @see spesifikasi atribut @see "almanak pengembang java"
Bentuk pertama mengacu pada metode yang disebut getName, yang terletak di kelas atau antarmuka yang sama dengan anotasi dokumen itu sendiri, atau di kelas sekitarnya atau antarmuka di sekitarnya. Sintaks semacam itu juga dapat diterapkan pada konstruktor dan bidang. Formulir kedua mengacu pada kelas dalam paket saat ini atau kelas dalam paket panduan tertentu. Formulir ketiga mengacu pada kelas menggunakan nama yang sepenuhnya memenuhi syarat.
The last 4 forms of @see refer to members, where the first two are about domains (DECK-SIZ day and method (getName). We can use the method name directly because only one getName method is defined in the Attr class. The latter two forms refer to the constructor of the Attr class, one of which accepts string quotes, and the other which accepts strings and objects. When the constructor or method has an overloaded version, we must specify the overloaded version quotes that Kami ingin merujuk.
Formulir @see berikutnya membawa pembaca ke paket tertentu: com.magic.attro
Dua bentuk terakhir memungkinkan kami untuk mengutip dokumen lain. Di antara mereka, yang sebelumnya digunakan untuk menentukan tautan, dan yang terakhir menggunakan kutipan untuk melampirkan nama dokumen. Kita dapat menggunakan kedua formulir untuk mengarahkan pembaca ke dokumen lain, seperti manual lengkap.
Formulir @See (semua bentuk kecuali dua bentuk terakhir di atas) yang nama entitas bahasa dapat diikuti oleh label. Dalam dokumen yang dihasilkan, nama label ini akan menggantikan nama entitas. Misalnya:
@ Lihat #GetNameattribute Names
Tautan ke dokumen getName akan dibuat, tetapi teks yang ditampilkan adalah "nama atribut" alih -alih "getName". Biasanya kita harus menggunakan nama asli anggota, tetapi fitur yang ditampilkan di sini kadang -kadang berguna.