자바독을 간단하게 알아보자 (JavaDoc)

자바를 사용하면 주석을 자연스럽게 활용하게 된다.

그런데 주석에도 종류가 있고 그 중에는 JavaDoc이라고 불리는 주석도 존재한다.

 

/**
*
*
*/

 

이런 형태로 작성된 주석을 JavaDoc, 자바 문서화라고 부른다.

실제로 저런 클래스, 메서드 위에 자바독 어노테이션과 함께 작성하면 해당 내용을 HTML로 바꿔서 자동으로 문서로 제작해준다. 문서화가 필수인 기업용 어플리케이션에서는 자주 사용하는 기능이다.

 

자바독 어노테이션에서 알아두면 좋은 어노테이션은 다음과 같다.

serializable 관련된 어노테이션은 자주 안 쓰는 것 같아서 배제했다.

 

/**
*
* @author : 작성자
*
* @deprecated : 지원 중단
*
* @exception :  예외 처리
*
* @param : 매개변수
*
* @return : 반환값
*
* @see : 참조
*
* @since : 작성일
*
* @throws : 예외처리하는 값에 대한 설명
*
* @version : 버전
*/