Bisakah seseorang memberi tahu saya perbedaan antara javadoc @see
dan {@link}
?
Atau lebih tepatnya, kapan harus menggunakan yang mana dari mereka?
The pedoman resmi mengenai hal ini cukup jelas.
Perbedaan fungsional adalah:
{@link}
adalah tautan sebaris dan dapat ditempatkan di mana pun Anda suka@see
membuat bagiannya sendiriMenurut pendapat saya, {@link}
paling baik digunakan ketika Anda benar-benar menggunakan nama kelas, bidang, konstruktor atau metode dalam deskripsi Anda. Pengguna akan dapat mengklik javadoc dari apa yang telah Anda tautkan.
Saya menggunakan @see
anotasi dalam 2 kasus:
Saya mendasarkan pendapat ini pada memeriksa secara acak dokumentasi untuk berbagai hal di perpustakaan standar.
@link
dalam komentar di atas) di panduan Javadoc Oracle .@see
membuat garis yang terisolasi di Javadocs.{@link}
adalah untuk menanamkan dalam teks.Saya menggunakan
@see
ketika itu adalah entitas terkait tetapi saya tidak merujuknya dalam teks ekspositori. Saya menggunakan tautan dalam teks ketika ada kopling ketat, atau (saya rasa) kemungkinan pembaca akan mendapat manfaat dari petunjuk navigasi, misalnya, Anda harus merujuknya secara langsung.sumber
Ada referensi lain (bantahan bagian) yang sama docs resmi untuk memilih
{@link}
lebih@see
(karena Jawa 1.2):sumber