Notice
Recent Posts
Recent Comments
Link
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 |
8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 | 16 | 17 | 18 | 19 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 | 30 | 31 |
Tags
- angularjs
- JavaFX
- Spring
- mybatis
- webflux
- SQL
- 외국인 노동자
- WebClient
- spring boot
- pdo
- RSocket
- maven
- bootstrap
- Python
- xml
- Linux
- 개발자 이야기
- node.js
- gradle
- Ajax
- swift
- Eclipse
- build tool
- SQLite
- 일본
- Java
- javadoc
- php
- jquery
- Apache
- Today
- 122
- Total
- 3,456,555
슬기로운 개발자 생활
[Javadoc] @version 태그 본문
반응형
@version 태그
@version
태그는 클래스, 인터페이스 등에 작성하고 소프트웨어의 버전을 지정하기 위해 사용한다.
@version version-text
소프트웨어 버전을 지정한다.
작성 위치 : 개요, 패키지, 클래스, 인터페이스
중복 작성 : 가능
출력 형식 : 버전
기 타 : "-version" 옵션 필요
소프트웨어의 현재 버전을 지정하는 경우에 사용한다. 같은 주석 내에서 여러 번 지정할 수 있다.
/**
* 주석의 설명문
*
* @version 1.0
* @version Project 2.0.1
*/
@version
태그가 중복으로 작성된 경우는 출력 될 때 각각의 버전이 쉼표(,)로 구분하여 한 줄에 모와서 출력된다.
비슷한 태그로 @since
가 있는데, 이 태그는 현재 버전이 아닌 도입 된 버전을 지정하는 경우에 사용한다.
주의한 점은 Javadoc의 -version
옵션을 지정한 경우에만 출력이 된다. -version
옵션에 대해서는 -version 옵션 페이지를 참조하길 바란다.
샘플
간단한 예제를 실습해 보도록 하자.
/**
* Javadoc 테스트용 클래스
*
* @version 1.0
* @version Project 2.0.1
*/
public class Sample06 {
/**
* 사이즈 설정
*
* @param width 폭
* @param height 높이
*/
public void setSize(int width, int height) {
}
}
위에 소스 코드를 "Sample06.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.
$ javadoc -d doc -version Sample06.java
생성된 "doc"디렉토리에 있는 "Sample06.html" 파일을 브라우저로 확인해 보자.
클래스의 설명 부분에 "버전(version)"으로 @version
에 작성한 버전이 표시되어 있다. @version
태그를 중복 지정하였기에 모와서 한줄로 표시된 것을 확인 할 수 있다.
반응형
'IT 개발 > Javadoc' 카테고리의 다른 글
[Javadoc] @deprecated 태그 (0) | 2019.10.20 |
---|---|
[Javadoc] @see 태그 (0) | 2019.10.20 |
[Javadoc] @author 태그 (0) | 2019.10.20 |
[Javadoc] 주석 필드에 대한 주석 작성 시에 주의점 (0) | 2019.10.20 |
[Javadoc] 주석 HTML문 작성 (0) | 2019.10.20 |
- Tag
- javadoc
0 Comments