Java 9 이전에는 특정 패키지, 클래스, 인터페이스, 메서드에 대한 정보를 확인하려면 구글 등 외부 검색 엔진을 활용해야 하는 번거로움이 있었습니다. 하지만 Java 9부터는 Javadoc 자체에 검색 기능이 포함되어 API 문서 내에서 바로 원하는 항목을 찾을 수 있게 되었으며, 생성되는 문서 역시 HTML5 표준을 준수하도록 개선되었습니다.
HTML5 호환 Javadoc이란?
HTML5 호환 문서는 모바일 기기에서의 가독성이 뛰어나고, 웹 접근성이 향상되며, 최신 브라우저 환경에서 더욱 안정적으로 동작한다는 장점이 있습니다. Java 9의 Javadoc 도구에 -html5 옵션을 추가하면 손쉽게 HTML5 표준에 맞는 문서를 만들 수 있습니다.
예제 코드 작성
다음 예제에서는 "C:/JAVA" 폴더에 "JavaDocTest.java" 파일을 생성했습니다.
public class JavaDocTest {
/**
* Tutorialspoint를 출력하는 기본 메서드
* @param args 명령줄 인자(command-line arguments)
*/
public static void main(String args[]) {
System.out.println("Tutorialspoint");
}
}-html5 옵션으로 문서 생성하기
Java 9에서 생성한 문서는 HTML5 표준과 호환됩니다. JDK 9의 Javadoc 명령어에 "-html5" 매개변수를 사용하면 생성되는 문서가 HTML5 표준을 지원하도록 설정할 수 있습니다.
C:\JAVA>javadoc -d C:/JAVA -html5 JavaDocTest.java Loading source file JavaDocTest.java... Constructing Javadoc information... Standard Doclet version 9.0.4 Building tree for all the packages and classes... Generating C:\JAVA\JavaDocTest.html... Generating C:\JAVA\package-frame.html... Generating C:\JAVA\package-summary.html... Generating C:\JAVA\package-tree.html... Generating C:\JAVA\constant-values.html... Building index for all the packages and classes... Generating C:\JAVA\overview-tree.html... Generating C:\JAVA\index-all.html... Generating C:\JAVA\deprecated-list.html... Building index for all classes... Generating C:\JAVA\allclasses-frame.html... Generating C:\JAVA\allclasses-noframe.html... Generating C:\JAVA\index.html... Generating C:\JAVA\help-doc.html...
위 명령어를 실행하면 다음과 같이 "C:/JAVA" 폴더 아래에 HTML5 형식의 문서 페이지가 생성됩니다.
정리
Java 9의 Javadoc은 검색 기능 내장과 HTML5 지원이라는 두 가지 큰 개선점을 제공합니다. -html5 옵션 하나만 추가하면 최신 웹 표준에 맞는 API 문서를 간편하게 만들 수 있으므로, 프로젝트 문서화 시 적극적으로 활용해 보시기 바랍니다.