a

Câu hỏi Liên kết đến một URL bên ngoài trong Javadoc?


Cái gì đó như:

/**
 * See {@linktourl http://google.com}
 */

615
2017-07-04 11:44


gốc




Các câu trả lời:


Điều này tạo tiêu đề "Xem thêm" chứa liên kết, tức 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 điều này:

/**
 * See <a href="http://google.com">http://google.com</a>
 */

sẽ tạo liên kết nội tuyến:

Xem http://google.com


964
2018-05-21 10:13



Nếu có ai quan tâm, vì tôi chỉ cần tra cứu nó: Theo Đặc tả Javadoc các @see thẻ đến sau các @param/@return thẻ và trước các @since/@serial/@deprecated thẻ. - 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
Tôi khuyên bạn nê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 javadoc html được tạo ra 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 chứ không chỉ là khung hiện tại. - Antony
Nếu bạn nhận được cảnh báo như "cảnh báo - Thẻ \ @see: thiếu cuối cùng '>':", hãy đảm bảo bạn không có hai siêu liên kết trong cùng một chỉ thị \ @see. Thay vào đó, hãy sử dụng một liên kết cho mỗi \ @see. - Travis Spencer
tại sao việc thêm một liên kết URL vào javadoc lại phức tạp đến vậy? những người nghĩ rằng HTML là một ý tưởng tốt ... / facepalm - Someone Somewhere


Lấy từ thông số javadoc

@see <a href="URL#value">label</a> : Thêm liên kết như được xác định bởi URL#value. Các 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 biểu tượng nhỏ hơn (<) là nhân vật đầu tiên.

Ví dụ : @see <a href="http://www.google.com">Google</a>


171
2017-07-04 11:50



Kỳ dị; Tôi thề tôi chỉ được thêm vào trong các backticks; Tôi không biết ví dụ về đâu ... - Stobor
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
Đủ 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
@see là không cần thiết. Các javadocs có thể được định dạng bằng các thẻ html, vì vậy nó chỉ cần thẻ "a". - Gabriel Llamas
@GabrielLlamas Đúng, nhưng câu hỏi ban đầu ngụ ý đây là cách nó được sử dụng. Nó rất hữu ích để biết rằng nó đặc biệt làm làm việc trong một lĩnh vực nhìn thấy cũng là nơi mà nhiều người sẽ muốn. - Ionoclast Brigham


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 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 là {@linkplain ...} vì đây là các liên kết tới javadocs của các lớp và phương thức khác.


25
2017-08-12 20:01





Chỉ cần sử dụng liên kết HTML với một phần tử như

<a href="URL#value">label</a>


8
2017-11-21 12:20



Chỉ cần đăng lại câu trả lời đúng khi nó nổi lê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


Khó tìm được 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";

4
2018-03-11 18:01



Ý nghĩa của việc gói <a> thẻ html với {@link ...}? - Patrick M
Đây có lẽ là một sai lầm bởi vì tài liệu javadoc không đề cập đến hình thức này, trong đó không tạo sự khác biệt từ một nguyên <a>. - Didier L
{@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
Cấu trúc này không được cho phép bởi các tiêu chuẩn Java 8 (doclint on). - Stepan Vavra
Điều này là sai. Cách sử dụng đúng theo tài liệu tham khảo và tài liệu Là {@link package.class#member label} - Dinei