[JAVA] JavaDoc 주석 (API주석)

 

 

JavaDoc

API 주석은 /** */으로 이뤄지며 해당 클래스에 대한 정보를 관리할 수 있다.

주요한 메서드 위에 API 주석을 작성하면 메서드에 대한 주석도 자동으로 작성된다. 해당 주석의 역할은 JAVA 소스코드에서 API문서를 HTML 태그 형식으로 작성하게 해주는 도구이다. 또한 컴파일 시 모든 주석은 지워지므로 프로그램 성능에는 영향이 가지 않는다.

 

JavaDoc Tags

어노테이션	내용
@version	구현체 버전
@author	작성자
@deprecate	해당 구현체가 곧 삭제, 업데이트 중단을 의미
@since	해당 구현체가 추가된 버전
@see	외부 링크나 텍스트, 다른 필드나 메서드를 링크할 때 사용
@link	see와 동일한 기능, 참조에 대한 링크 제공
@exception	발생할 수 있는 Exception 정의
@throws	코드에서 throw 할 수 있는 예외상황 정리
@param	메서드의 매개변수 / 인자값 설명
@return	반환값
@serial	Serializavle Interface에 사용
@serialDate	writeObject writeExtemal 메서드로 작성된 추가적 데이터를 설명
@serialField	serialPersistnetFields 배열의 모든 필드에 사용

 

 

+ API 문서 제작

 

오라클에서 제공하는 JAVA API 문서와 같은 문서를 API 주석을 사용해 제작할 수 있다.

cmd를 이용하는 방법도 있고, 이클립스에서 생성하는 방법도 있다.