2.7.1 주석 넣기

javadoc 유틸리티는 다음 정보를 추출한다.

• 공개 클래스와 인터페이스

• 공개·보호 생성자와 메서드

• 공개·보호 변수

• 패키지와 모듈

인터페이스는 3장 인터페이스와 람다 표현식에서 자세히 설명하고, 보호 기능은 4장 상속과 리플렉션에서 자세히 설명한다.

이런 기능에는 각각 주석을 달 수 있고, 또 그렇게 해야 한다. 주석은 설명할 기능 바로 위에 붙인다. 주석은 /**로 시작하고 */로 마친다.

문서화 주석(/** … */)에는 자유 형식 텍스트와 그 뒤에 태그들을 적는다. 태그는 @author나 @param처럼 @ 기호로 시작한다.

자유 형식 텍스트의 첫 번째 문장은 요약문이어야 한다. javadoc 유틸리티는 이 요약문들을 추출해서 자동으로 요약 페이지를 만든다.

자유 형식 텍스트에는 강조를 나타내는 HTML 태그 <em>…</em>, 고정 폭인 ‘타자기’ 폰트로 표시하는 <code>…</code>, 볼드로 표시하는 <strong>…</strong>, 심지어 이미지를 포함하는 <img…>까지 사용할 수 있다. 하지만 제목 태그 <hn>이나 수평 구분선 태그 <hr>은 문서 형식과 충돌할 수 있으므로 사용하지 말아야 한다.