568
Cái gì như:Liên kết đến một URL bên ngoài trong Javadoc?
/**
* See {@linktourl http://google.com}
*/
A
Trả lời
886
này tạo ra một "Thấy Cũng" tiêu đề có chứa các liên kết, ví dụ:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
sẽ làm như sau:
See Also:
http://google.com
trong khi điều này:
/**
* See <a href="http://google.com">http://google.com</a>
*/
sẽ tạo ra một liên kết trong-line:
167
Taken từ javadoc spec
@see <a href="URL#value">label</a>: Thêm một liên kết theo quy định của URL#value. URL#value là 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 ký hiệu ít hơn (<) làm ký tự đầu tiên.
Ví dụ: @see <a href="http://www.google.com">Google</a>
+0
Lạ; Tôi thề tôi chỉ được thêm vào trong các backticks; Tôi không biết ví dụ đã đi đến đâu ... – Stobor
+0
Tôi nghĩ rằng chúng tôi đã có một số loại vấn đề chỉnh sửa đồng thời. Tôi cũng đã đưa chúng vào. – Aaron
+0
Đủ công bằng. Bạn đang thiếu backticks trong dòng đầu tiên của blockquote của bạn, mặc dù .... – Stobor
8
Chỉ cần sử dụng một liên kết HTML với một yếu tố giống như
<a href="URL#value">label</a>
+0
Chỉ cần đăng lại câu trả lời đúng khi nó xuất hiện từ các bình luận khác. Điều này sẽ được đọc nhanh hơn toàn bộ chuỗi. – xamde
2
cứng để tìm một câu trả lời rõ ràng từ các trang web 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";
+0
Ý nghĩa của việc bao bọc thẻ '' html với '{@link ...}' là gì? –
+1
Đây có thể là một sai lầm vì [tài liệu javadoc] (http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#@link) không đề cập đến biểu mẫu này, trong đó không tạo sự khác biệt so với ' '. –
+3
{@link xxx} ở đây không đúng. {@link xxx} dành cho liên kết đến các lớp và phương pháp khác trong mã nguồn của bạn. Nó không cần thiết ở đây. Phần còn lại của nó là tốt. – MiguelMunoz
21
Javadocs tôi không cung cấp bất kỳ công cụ đặc biệt 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
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
Don' t sử dụng {@link ...} hoặc {@linkplain ...} vì đây là các liên kết đến javadocs của các lớp và phương pháp khác.
Nếu có ai quan tâm, vì tôi chỉ cần tra cứu nó: Theo [Javadoc spec] (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#orderoftags) Thẻ '@ see' xuất hiện * sau * các thẻ' @ param'/'@ return' và * trước * các thẻ' @ since'/'@ serial' /' @ deprecated'. – friederbluemle
Chỉ trong trường hợp, Intellij 13 dường như không hỗ trợ thẻ này. Nó hỗ trợ các liên kết trực tuyến. Thẻ có bị từ chối không? – Timo
Khi tôi sử dụng điều này với Maven, nó cảnh báo về một thiếu sót lớn hơn biểu tượng - bất cứ ai biết tại sao? –