[Javadoc] @since 태그

반응형

@since 태그

@since 태그 도입된 버전을 표시하는 경우에 사용한다. @version 태그는 현재의 버전을 나타내는 반면 @since 태그는 어떤 버전에서 도입 되었는지 나타내는 점이 다르다.

@since since-text

도입 된 버전을 표시한다.

작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드
중복 작성 : 가능
출력 형식 : 도입 된 버전

버전 등을 나타내는 문자열을 지정한다. 사용법은 다음과 같다.

/**
 * 주석의 설명문
 * @since 2.5.1
 */

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

실습

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

/**
 * Javadoc 테스트용 클래스
 *
 * @since 2.5.1
 * @since Project 1.4A
 */
public class Sample10 {

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

    }
}

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

$ javadoc -d doc Sample10.java

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

@since 태그를 중복 지정하였기에 모와서 한줄로 표시된 것을 확인 할 수 있다.

반응형

저작자표시비영리변경금지

'Javadoc' 카테고리의 다른 글

[Javadoc] @return 태그  (0)	2019.10.20
[Javadoc] @param 태그  (0)	2019.10.20
[Javadoc] @since 태그  (0)	2019.10.20
[Javadoc] @deprecated 태그  (0)	2019.10.20
[Javadoc] @see 태그  (0)	2019.10.20
[Javadoc] @version 태그  (0)	2019.10.20