반응형

주석에는 설명문과 Javadoc 태그를 작성할 수 있다. 여기에서는 Javadoc 태그에 대해 설명한다. 인수와 반환 값, 예외 및 참고하는 곳의 지정 등 해당 Javadoc 태그와 값이 같이 지정된다.


@author 태그

@author 태그는 클래스 클래스, 인터페이스 등에 작성하고, 작성자를 지정하는데 사용한다.

@author name-text

저자에 관하여 지정한다.

작성 위치 : 개요, 패키지, 클래스, 인터페이스
중복 작성 : 가능
출력 형식 : 작성자
기    타 : "-author" 옵션 필요

주로 클래스 등의 주석을 작성하고, 저자가 누구인지를 지정하는 경우에 사용한다. 같은 주석 내에서 여러 번 지정할 수 있다.

/**
 * 주석의 설명문
 * @author devkuma
 * @author kimkc
 */

@author 태그가 중복으로 작성된 경우는 출력 될 때 각각의 저자가 쉼표(,)로 구분하여 한 줄에 모와서 출력된다.

참고로 Javadoc의 -author옵션을 지정한 경우에만 출력이 된다. -author 옵션에 대해서는 -author 옵션 페이지를 참조하길 바란다.

실습

간단한 예제를 실습해 보도록 하자.

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

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

    }
}

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

$ javadoc -d doc -author Sample05.java

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


클래스의 설명 부분에 "작성자(author)"로 @author에 작성한 이름이 표시되어 있다. @author 태그를 중복 지정하였기에 모와서 한줄로 표시된 것을 확인 할 수 있다.

반응형

'Javadoc' 카테고리의 다른 글

[Javadoc] @see 태그  (0) 2019.10.20
[Javadoc] @version 태그  (0) 2019.10.20
[Javadoc] @author 태그  (0) 2019.10.20
[Javadoc] 주석 필드에 대한 주석 작성 시에 주의점  (0) 2019.10.20
[Javadoc] 주석 HTML문 작성  (0) 2019.10.20
[Javadoc] 주석의 구성  (0) 2019.10.20

+ Recent posts