Câu trả lời:
Điều này tạo ra một tiêu đề "Xem thêm" có chứa liên kết, nghĩa là:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
sẽ hiển thị dưới dạng:
Xem thêm:
http://google.com
trong khi đó
/**
* See <a href="http://google.com">http://google.com</a>
*/
sẽ tạo một liên kết nội tuyến:
<a href="http://google.com" target="_top">http://google.com</a>.
Lý do để thêm target = "_ top" là vì một số tệp html javadoc được tạo sử dụng các khung và bạn có thể muốn điều hướng ảnh hưởng đến toàn bộ trang thay vì chỉ khung hiện tại.
Lấy từ thông số javadoc
@see <a href="URL#value">label</a>
: Thêm một liên kết như được xác định bởi URL#value
. Đây URL#value
là một URL tương đối hoặc tuyệt đối. Công cụ Javadoc phân biệt điều này với các trường hợp khác bằng cách tìm kiếm một ký hiệu nhỏ hơn ( <
) là ký tự đầu tiên.
Ví dụ : @see <a href="http://www.google.com">Google</a>
Javadocs không cung cấp bất kỳ công cụ đặc biệt nào cho các liên kết bên ngoài, vì vậy bạn chỉ nên sử dụng html tiêu chuẩn:
See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.
hoặc là
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
Không sử dụng {@link ...}
hoặc {@linkplain ...}
bởi vì đây là cho các liên kết đến javadocs của các lớp và phương thức khác.
Chỉ cần sử dụng một liên kết HTML với một yếu tố như
<a href="URL#value">label</a>
Khó tìm thấy một câu trả lời rõ ràng từ trang web của Oracle. Sau đây là từ 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>
thẻ html với là {@link ...}
gì?
<a>
.
{@link package.class#member label}
@see
thẻ xuất phát sau khi các@param
/@return
thẻ và trước sự@since
/@serial
/@deprecated
thẻ.