@seeJavaDocs를 다룰 때 언제 사용 합니까? 그 사용법은 무엇입니까?
예를 들어 경우 MethodA통화 MethodB후 내가 넣어해야합니까 @see에서 MethodB의 Javadoc을 참조 MethodA그게라는 것 때문에, 또는 내가에 대한 참조를 넣어해야합니까 MethodB에서 MethodA그것을 부르고 있기 때문이다. 나는 @see오라클 웹 사이트에 대한 내용 을 읽었고 믿을 수 없을 정도로 모호한 것 같습니다. “도보 기”를 의미하지만 실제로는 그 의미가 아닙니다!
답변
네, 아주 모호합니다.
당신은 당신의 방법에 대한 문서를 읽는 독자들이 다른 방법을 살펴 보는 것이 유용 할 때마다 그것을 사용해야합니다. methodA의 문서에 “Works like methodB but …”가 표시되어 있으면 반드시 링크를 넣어야합니다. 대신 @see인라인 {@link ...}태그가 있습니다.
/**
* ...
* Works like {@link #methodB}, but ...
*/
methodA가 methodB를 호출한다는 사실이 구현 세부 사항이고 외부와의 실제 관계가없는 경우 여기에 링크가 필요하지 않습니다.
답변
@see는 API의 관련 메서드 / 클래스에 대한 정보에 유용합니다. 문서에서 참조 된 메서드 / 코드에 대한 링크를 생성합니다. 사용자가 API 사용 방법을 이해하는 데 도움이 될 수있는 관련 코드가있을 때 사용하십시오.
답변
@see유용 할 수 있는 상황의 좋은 예 는 인터페이스 / 추상 클래스 메서드를 구현하거나 재정의하는 것입니다. 선언 javadoc에는 메서드를 자세히 설명하는 섹션 이 있으며 재정의 / 구현 된 메서드 @see는 기본 태그를 참조 하는 태그를 사용할 수 있습니다 .
관련 질문 :
@see로 적절한 javadoc 작성?
Java SE 문서 : @see
답변
인터페이스의 javadoc에 이미 메소드에 대한 설명이 제공되어있는 인터페이스 구현 클래스의 메소드에 주석을 달기 위해 @see를 사용합니다. 그렇게 할 때 코드가 완료되는 동안 구현 참조에서 메서드를 찾을 때에도 Eclipse가 인터페이스의 문서를 가져 오는 것을 알 수 있습니다.
답변
