-author 옵션

-author 옵션은 생성된 문서에 @author 태그로 지정된 저자를 출력하도록 지정한다. "-author" 옵션이 지정되지 않을 경우 @author 태그가 주석에 작성이 되어 있어도 생성되는 문서에 저자는 출력되지 않는다.

※ @author 태그에 대해서는 @author 태그 페이지를 참조하길 바란다.

사용법은 다음과 같다.

$ javadoc -author [대상 파일]

예를 들어 다음과 같이 실행합니다.

$ javadoc -author Sample.java

실습

간단한 예를 실습해 보도록 하겠다.

/**
 * Javadoc 테스트용 클래스
 *
 * @author devkuma
 */
public class Sample05_1 {

    /**
     * 사이즈 설정
     *
     * @param width 폭
     * @param height 높이
     */
    public void setSize(int width, int height) {

    }
}

위에 소스 코드를 "Sample05_1.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.

$ javadoc -d doc -author Sample05_1.java

생성된 "doc"디렉토리에 있는 "Sample05.html" 파일을 브라우저로 확인해 보자.

위와 같이 작성자에 대해 @author 태그에서 지정한 저자가 표시된다.

그럼 동일한 소스 파일로 -author 옵션을 지정하지 않고 다음과 같이 실행해 보자.

$ javadoc -d doc Sample05_1.java

생성된 "doc"디렉토리에 있는 "Sample05_1.html" 파일을 브라우저로 다시 확인해 보자.

이번에는 @author 태그가 작성이 되어 있어도 작성자는 표시되지 않는다.

'Javadoc' 카테고리의 다른 글

[Javadoc] -version 옵션  (0) 2019.10.20
[Javadoc] -author 옵션  (0) 2019.10.20
[Javadoc] -d 옵션  (0) 2019.10.20
[Javadoc] -help 옵션  (0) 2019.10.20
[Javadoc] {@code} 태그  (0) 2019.10.20
[Javadoc] {@link}, {@linkplain} 태그  (0) 2019.10.20

+ Recent posts