더북(TheBook)

2.7.7 패키지 주석, 모듈 주석, 개요 주석


클래스 주석, 메서드 주석, 변수 주석은 /z***/로 구분해서 자바 소스 파일에 직접 넣는다. 하지만 패키지 주석을 만들려면 각 패키지 디렉터리에 파일을 따로 추가해야 한다.

패키지 디렉터리에 자바 파일 package-info.java를 추가한다. 이 파일의 첫 부분에는 /***/로 구분한 자바독 주석이 있어야 하고, 그 뒤에는 패키지 문이 있어야 한다. 패키지 문 뒤에는 코드나 주석을 적지 말아야 한다.

모듈을 문서화하려면 module-info.java 파일에 주석을 넣어야 한다. @moduleGraph 지시문을 사용하면 모듈 의존성 그래프(module dependency graph)를 넣을 수 있다(모듈과 module-info.java 파일은 15장 자바 플랫폼 모듈 시스템을 참고한다).

모든 소스 파일에 개요 주석을 넣을 수도 있다. 개요 주석은 overview.html 파일에 넣는데, 이 파일은 모든 소스 파일이 들어 있는 부모 디렉터리에 만든다. <body></body> 태그 사이에 있는 텍스트는 모두 추출된다. 이 주석은 사용자가 내비게이션 바에서 ‘개요(overview)’를 선택하면 표시된다.

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