Javadoc 만들기 | Javadoc 옵션 지정 | -version 옵션
-version
옵션은 생성된 문서에 @version
태그로 지정된 버전을 출력하도록 지정한다. -version
옵션이 지정되지 않을 경우 @version
태그가 코멘트 중에 작성되어 있어도 생성되는 문서 버전은 출력되지 않는다.
※ @version
태그에 대해서는 @version 태그 페이지를 참조하길 바란다.
사용법은 다음과 같습니다.
$ javadoc -version [대상 파일]
예를 들어 다음과 같이 실행합니다.
$ javadoc -version Sample.java
실습
간단한 예를 실습해 보도록 하겠다.
/**
* Javadoc 테스트용 클래스
*
* @version 1.0
*/
public class Sample06_1 {
/**
* 사이즈 설정
*
* @param width 폭
* @param height 높이
*/
public void setSize(int width, int height) {
}
}
위에 소스 코드를 “Sample06_1.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.
$ javadoc -d doc -version Sample06_1.java
생성된 “doc"디렉토리에 있는 “Sample06_1.html” 파일을 브라우저로 확인해 보자.
위와 같이 버전에 대해 @version
태그에서 지정한 저자가 표시된다.
그럼 동일한 소스 파일로 -version
옵션을 지정하지 않고 다음과 같이 실행해 보자.
$ javadoc -d doc Sample06_1.java
생성된 “doc"디렉토리에 있는 “Sample06_1.html” 파일을 브라우저로 다시 확인해 보자.
이번에는 @version
태그가 작성이 되어 있어도 버전는 표시되지 않는다.