더북(TheBook)

패키지 이름은 생략할 수 있고, 패키지 이름과 클래스 이름을 둘 다 생략할 수도 있다. 이렇게 하려면 해당 기능이 현재 패키지나 클래스에 있어야 한다.

클래스를 메서드나 변수 이름과 구분할 때는 점(.)이 아니라 #을 사용해야 한다. 자바 컴파일러는 패키지, 서브패키지, 클래스, 내부 클래스, 클래스의 메서드와 변수 사이에서 구분자 역할을 하는 점 문자의 다양한 의미를 잘 추측한다. 하지만 javadoc 유틸리티는 그만큼 똑똑하지 못하므로 개발자가 도와주어야 한다.

@see 태그 뒤에 < 문자가 오면 하이퍼링크를 의미한다. 원하는 어떤 URL이든 링크할 수 있다. 예를 들어 @see <a href="http://en.wikipedia.org/wiki/Leap_year">Leap years</a>처럼 사용한다.

앞의 첫 번째와 두 번째 예제 태그 각각에 링크 앵커로 표시될 레이블을 추가로 명시할 수 있다. 레이블을 생략하면 사용자는 링크 대상의 코드 이름이나 URL을 앵커로 보게 된다.

@see 태그 뒤에 " 문자가 오면 다음과 같이 큰따옴표 안에 있는 텍스트가 ‘참고’ 섹션에 표시된다.

@see "Core Java for the Impatient"


기능 하나에 @see 태그를 여러 개 추가할 수 있지만, 이때는 @see 태그들을 반드시 함께 두어야 한다.

원한다면 모든 문서화 주석의 어느 위치든 다른 클래스나 메서드의 하이퍼링크를 넣을 수 있다. 주석의 어느 위치에서든 다음 형식으로 된 태그를 삽입하면 된다.

{@link package.Class#feature label}


기능 설명은 @see 태그와 같은 규칙을 따른다.

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