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


답변:


1224

링크가 포함 된 "참조"제목이 작성됩니다.

/**
 * @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를


59
누군가가 관심이 있다면 난 그냥 가지고 있기 때문에, 그것을 찾으려면 다음에 따르면 자바 독 사양@see 태그가 온다 @param / @return태그 전에@since / @serial/ @deprecated태그.
friederbluemle

7
Intellij 13이이 태그를 지원하지 않는 것 같습니다. 인라인 링크를 지원합니다. 태그가 어떻게 사용되지 않습니까?
Timo

24
내가 추천 <a href="http://google.com" target="_top">http://google.com</a>. 생성 된 자바 독 HTML 파일의 일부 프레임을 활용, 당신은 아마 탐색 그냥 현재 프레임이 아니라 전체 페이지에 영향을 원하기 때문에 대상을 추가하는 이유를 = "_ 최고"입니다.
Antony

3
"경고-태그 \ @see : 누락 된 마지막 '>':"과 같은 경고가 표시되면 동일한 \ @see 지시문에 두 개의 하이퍼 링크가 없는지 확인하십시오. 대신 \ @see 당 하나의 링크를 사용하십시오.
트래비스 스펜서

7
javadoc에 URL 링크를 추가하는 것이 왜 그렇게 복잡한가? HTML이 좋은 아이디어라고 생각한
사람

189

javadoc 스펙 에서 가져온

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

예를 들면 다음과 같습니다. @see <a href="http://www.google.com">Google</a>


기묘한; 나는 역행에만 추가 한 것을 맹세한다. 예제가 어디로 갔는지
모르겠습니다

동시 편집 문제가 있다고 생각합니다. 나는 또한 그것들을 넣었다.
Aaron

그럴 수 있지. 하지만 인용구의 첫 줄에 백틱이 빠졌습니다 ..
Stobor

27
@ 참조가 필요하지 않습니다. javadoc은 html 태그로 형식화 할 수 있으므로 "a"태그 만 필요합니다.
가브리엘 라마

5
@GabrielLlamas 사실이지만 원래의 질문은 이것이 어떻게 사용되는지 암시합니다. 그것은 구체적으로 알고 유용 하지 많은 사람들이 원하는 곳입니다 참조 - 또한 현장에서 일을.
Ionoclast Brigham

33

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 ...}이 다른 클래스와 메소드의 JavaDoc을 링크 때문이다.


16

a-element와 같은 HTML 링크를 사용하십시오.

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


다른 의견에서 나온 정답을 다시 게시했습니다. 이것은 전체 스레드보다 읽기가 더 빠릅니다.
박사 맥스 Völkel

4

오라클 사이트에서 명확한 답변을 찾기가 어렵습니다. 다음은 다음과 같습니다 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>html 태그를 {@link ...}? 로 감싸는 것은 무엇을 의미 합니까?
Patrick M

2
javadoc 문서 가이 양식을 언급하지 않았기 때문에 아마도 실수 일 것입니다 .raw 와 차이가 없습니다 <a>.
Didier L

4
{@link xxx}가 잘못되었습니다. {@link xxx}는 소스 코드의 다른 클래스 및 메소드에 연결하기위한 것입니다. 여기서는 불필요합니다. 나머지는 괜찮습니다.
MiguelMunoz

4
이 구문은 Java 8 표준 (doclint on)에서 허용되지 않습니다.
Stepan Vavra

1
이것은 명백한 잘못입니다. 당 등의 올바른 사용법 참조문서 입니다{@link package.class#member label}
Dinei
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.