Javadoc @see 또는 {@link}?

Question

누군가가 javadoc @see과 {@link}의 차이점을 말해 줄 수 있습니까?

오히려 언제 사용합니까?

Answer 1

official guidelines은 매우 분명합니다.

기능적인 차이점은 다음과 같습니다

• {@link} 인라인 링크하고 배치 할 수는
• @see을 원하는 위치 내 생각에 자신의 섹션

를 생성, {@link} 가장 때 사용 말 그대로, 클래스, 필드, 생성자 또는 메서드 이름을 사용하십시오. 사용자는 링크 한 항목의 javadoc을 클릭 할 수 있습니다.

내가 2 경우에 @see 주석을 사용

• 뭔가 매우 관련이 있지만, 설명에서 언급되지.
• 동일한 내용을 설명에서 여러 번 참조하며 동일한 내용에 대한 여러 링크를 대체하기 위해 사용됩니다.

나는이 견해를 무작위로 표준 라이브러리의 다양한 것들에 대한 문서를 체크 아웃에 대한 기반으로합니다.

Answer 2

@see은 Javadocs에서 격리 된 행을 만듭니다. {@link}은 텍스트 내에 삽입하기위한 것입니다.

관련 엔터티 인 경우 @see을 사용하지만 설명문에서이 항목을 참조하지 않습니다. 타이트 커플 링이있을 때 텍스트 내에서 링크를 사용합니다. 또는 독자가 탐색 힌트의 이점을 누릴 가능성이 있습니다 (예를 들어, 직접 참조해야 할 필요가 있음).