Jawaban:
Ini menciptakan tajuk "Lihat Juga" yang berisi tautan, yaitu:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
akan dirender sebagai:
Lihat Juga:
http://google.com
sedangkan ini:
/**
* See <a href="http://google.com">http://google.com</a>
*/
akan membuat tautan sebaris:
Lihat http://google.com
<a href="http://google.com" target="_top">http://google.com</a>.
Alasan untuk menambahkan target = "_ top" adalah karena beberapa file html javadoc yang dihasilkan menggunakan frame, dan Anda mungkin ingin navigasi mempengaruhi seluruh halaman daripada hanya frame saat ini.
Diambil dari spec javadoc
@see <a href="URL#value">label</a>
: Menambahkan tautan seperti yang didefinisikan oleh URL#value
. Ini URL#value
adalah URL relatif atau absolut. Alat Javadoc membedakan ini dari kasus lain dengan mencari simbol yang kurang dari ( <
) sebagai karakter pertama.
Sebagai contoh : @see <a href="http://www.google.com">Google</a>
Javadocs tidak menawarkan alat khusus untuk tautan eksternal, jadi Anda harus menggunakan html standar:
See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.
atau
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
Jangan gunakan {@link ...}
atau {@linkplain ...}
karena ini untuk tautan ke javadocs dari kelas dan metode lain.
Cukup gunakan tautan HTML dengan elemen-a seperti
<a href="URL#value">label</a>
Sulit menemukan jawaban yang jelas dari situs Oracle. Berikut ini dari javax.ws.rs.core.HttpHeaders.java
:
/**
* See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">HTTP/1.1 documentation</a>}.
*/
public static final String ACCEPT = "Accept";
/**
* See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2">HTTP/1.1 documentation</a>}.
*/
public static final String ACCEPT_CHARSET = "Accept-Charset";
<a>
tag html dengan {@link ...}
?
<a>
.
{@link package.class#member label}
@see
tag datang setelah para@param
/@return
tag dan sebelum yang@since
/@serial
/@deprecated
tag.