JAVADOC

javadoc 프로그램은 .java 소스 파일에 포함되어 있는 클래스와 변수, 그리고 메소드의 이름은 물론 프로그래머가 소스 파일에 붙여놓은 주석을 포함하는 HTML 파일을 자동으로 생성해 준다. 자바에서 기본적으로 제공하고 있는 자바 API 가이드는 바로 이 프로그램을 이용하여 만들어진 것이다.
프로그래머가 /** */를 이용하여 붙여 놓은 주석은 자동으로 포함된다.

작성될 도큐먼트용 HTML 파일이 포함하고 있는 내용을 서로 링크해주기 위해서 다음과 같은 태그를 이용할 수 있다.

• @see classname "See also"라는 항목을 만들어 해당 클래스와 연결해 준다.
• @see classname#methodname "See also"란 항목을 만들어 특정 메소드와 연결해 준다.
• @version text HTML 파일의 버전을 표시하는 항목을 만들어 준다.
• @author text HTML 파일의 저자를 표시하는 항목을 만들어 준다.
• @param name description 특정 메소드가 취하는 인자를 기술할 때 사용한다.
• @return description 특정 메소드의 리턴값을 기술할 때 사용한다.
• @exception classname 특정 메소드가 발생시킬 수 있는 예외를 기술할 때 사용한다.

　

　
• -classpath path .java 파일이 있는 경로명을 지정해줄 때 사용한다.
• -d directory 만들어질 HTML 파일을 저장할 경로를 지정해 준다.
• -encoding encoding 소스 파일의 문자 인코딩을 지정한다.
• -docencoding document_encoding 만들어질 HTML 문서의 문자 인코딩을 지정한다.