Programing

Javadoc의 외부 URL에 연결 하시겠습니까?

crosscheck 2020. 9. 30. 08:42
반응형

Javadoc의 외부 URL에 연결 하시겠습니까?


다음과 같은 것 :

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

그러면 링크가 포함 된 "참조 항목"제목이 생성됩니다.

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

다음과 같이 렌더링됩니다.

참조 :
           http://google.com


반면 이것은 :

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

인라인 링크를 생성합니다.

참조 http://google.com를


javadoc 사양 에서 가져옴

@see <a href="URL#value">label</a>:에 정의 된대로 링크를 추가합니다 URL#value. URL#value상대 또는 절대 URL이다. Javadoc 도구 <는 첫 번째 문자로 보다 작음 기호 ( )를 찾아 다른 경우와 구별 합니다.

예 : @see <a href="http://www.google.com">Google</a>


Javadocs는 외부 링크를위한 특별한 도구를 제공하지 않으므로 표준 html 만 사용해야합니다.

See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.

또는

@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of 
the Martian invasion.

{@link ...}또는 {@linkplain ...}다른 클래스 및 메서드의 javadocs에 대한 링크 용이므로 사용하지 마십시오 .


다음과 같은 요소가있는 HTML 링크를 사용하십시오.

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


Oracle 사이트에서 명확한 답변을 찾기가 어렵습니다. 다음은 보낸 사람 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";

참고 URL : https://stackoverflow.com/questions/1082050/linking-to-an-external-url-in-javadoc

반응형