Apakah ada cara untuk menambahkan referensi ke satu atau lebih parameter metode dari badan dokumentasi metode? Sesuatu seperti:
/**
* When {@paramref a} is null, we rely on b for the discombobulation.
*
* @param a this is one of the parameters
* @param b another param
*/
void foo(String a, int b)
{...}
@code
tag dijelaskan dalam Javadoc - Deskripsi Tag . Lihat Contoh penggunaan dalam kode JDK8 .Seperti yang Anda lihat di Sumber Java dari kelas java.lang.String:
Referensi parameter dikelilingi oleh
<code></code>
tag, yang berarti bahwa sintaksis Javadoc tidak menyediakan cara apa pun untuk melakukan hal seperti itu. (Saya pikir String.class adalah contoh penggunaan javadoc yang baik).sumber
Cara yang benar merujuk ke parameter metode adalah seperti ini:
sumber
Saya kira Anda dapat menulis doclet atau taglet Anda sendiri untuk mendukung perilaku ini.
Ikhtisar Taglet
Ikhtisar Doclet
sumber