더북(TheBook)

2.7.5 일반 주석


모든 문서화 주석에 @since 태그로 해당 기능을 도입한 버전을 적을 수 있다.

@since version 1.7.1


@deprecated 태그에는 해당 클래스, 메서드, 변수를 사용하지 말아야 한다는 주석을 추가한다. 설명에는 대체 방법을 제안해야 한다.

@deprecated Use <code>setVisible(true)</code> instead


Note ≣

비권장 항목을 사용했을 때 컴파일러가 경고를 표시하는 @Deprecated 애너테이션도 있다(11장 애너테이션 참고). 애너테이션에는 대체 방법을 제안하는 메커니즘이 없으므로 비권장 항목에는 애너테이션과 자바독 주석(문서화 주석)을 모두 붙여야 한다.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.