경진의 블로그

Javadoc 태그 본문

자바개발과정/기타(ETC)

Javadoc 태그

aith 2008. 7. 14. 01:04
Javadoc 태그

태그명
Ver
중요
설명
@author
1.0

클래스의 저작자를 입력한다. author 옵션이 지정되었을 때만 표시된다

{@docROOT}
1.3
저작자의 홈페이지와 회사 로고 등 인덱스 페이지의 상대 경로
@deprecated
1.0
충돌하지 않는 API라는 것을 나타낸다. 생성된 페이지에서는 '충돌하지 않는다'고 표시된다. 또한 Javac(컴파일)에서 경고가 출력되고, Eclipse에서는 타스크에 경고가 표시된다
@exception
1.0
예외 상황의 설명을 적는다 (@throws와 동일함)
{@inheritDoc}
1.4
슈퍼 클래스의 Javadoc 주석을 삽입한다
{@link}
1.2
다른 API에의 참조 사항을 입력한다. 완전한 클래스명을 생략 클래스명으로 입력할 수 있다
{@linkplain}
1.2
@link와 거의 유사하다. link에서는 작성된 HTML이 <code>로 둘러싸여 있지만, @linkplain은 둘러싸여 있지 않다는 점이 다르다
@param
1.0
메소드의 인수에 대한 설명을 입력한다
@return
1.0
메소드의 반환값에 대한 설명을 입력한다
@see
1.0
@link와 작성 방법 및 의미는 거의 같다 단, @link는 Javadoc 주석 중에 링크를 걸 수 있지만, @see는 관련 항목 액세스에 배치된다
@serial
1.2
시리얼 필드의 설명을 입력한다
@serialData
1.2
시리얼 형식의 데이터 형식과 순서를 설명한다
@serialField
1.1
Serializable 클래스에 관한 설명을 입력한다
@since
1.1
도입된 버전을 입력한다
@throws
1.2
예외 상황에 대한 설명을 입력한다 (@exception과 동일함)
{@valie}
1.4
static 필드 주석 안에 사용하면 정수값을 표시한다
@version
1.0
버전을 입력한다
0 Comments
댓글쓰기 폼