누군가 javadoc @see과 의 차이점을 말해 줄 수 {@link}있습니까?
또는 어느 쪽을 언제 사용해야합니까?
답변
이것에 대한 공식 지침 은 매우 분명합니다.
기능상의 차이점은 다음과 같습니다.
{@link}인라인 링크이며 원하는 곳에 배치 할 수 있습니다@see자체 섹션을 만듭니다
내 의견으로 {@link}는 말 그대로 설명에 클래스, 필드, 생성자 또는 메서드 이름을 사용할 때 가장 잘 사용됩니다. 사용자는 링크 한 내용의 javadoc을 클릭하여 클릭 할 수 있습니다.
@see두 가지 경우에 주석을 사용합니다 .
- 설명과 관련이 있지만 언급되지 않은 내용이 있습니다.
- 설명에서 동일한 것을 여러 번 참조하며 동일한 링크를 여러 번 대체하는 것으로 사용됩니다.
나는이 의견을 표준 라이브러리에서 매우 다양한 것들에 대한 문서를 무작위로 체크 아웃하는 것에 기초했다.
답변
@seeJavadocs에 분리 된 줄을 만듭니다. {@link}텍스트 안에 포함하기위한 것입니다.
나는 @see그것이 관련 엔터티 일 때 사용 하지만 설명 텍스트에서 언급하지는 않습니다. 긴밀한 결합이있을 때 텍스트 내에 링크를 사용하거나 독자가 탐색 힌트의 이점을 누릴 수 있다고 생각합니다 (예 : 직접 참조해야 함).
답변
같은 다른 참조 (중단 섹션)있어 공식 문서가 선호하는 {@link}이상 @see(자바 1.2 이후는)
Javadoc 1.2 이상의 경우 표준 형식은 @deprecated 태그와 인라인 {@link} 태그를 사용하는 것입니다. 그러면 원하는 위치에 링크가 인라인으로 작성됩니다. 예를 들면 다음과 같습니다.
Javadoc 1.1의 경우 표준 형식은 @deprecated 및 @see 태그 쌍을 작성하는 것입니다. 예를 들면 다음과 같습니다.
