Java 문서주석
Java 문서주석이란 JavaDoc툴을 이용하여 HTML형태로 추출하여 보기 예쁘게 문서화 할 수 있는 주석 형태이다. JavaDoc키워드로 검색하면 휘황찬란한 주석들을 볼 수 있는데 머리가 나빠서 그렇게까지 작성하진 못하고 정말 기본적인 것들을 적어보았다.
작성 방법
/** */으로 감싼다. 여러줄 작성이 가능하다.- Java 태그라는 것이 있다. 정의된 것들이 몇가지 있으며 태그 앞에 @붙여 사용할 수 있다.
| 태그 | 설명 |
|---|---|
| @author | 이름 클래스나 인터페이스의 제작자 표시 |
| @version | 테스트 클래스나 인터페이스에서의 버전 정보 |
| @param | 매개변수 - 매개변수에 대한 설명 |
| @return | 메소드 반환값에 대한 설명 |
| @exception @throws | 메소드가 발생시킬 수 있는 예외를 기술 둘중 아무거나 사용해도 똑같지만 나중에 추가된 @throws사용이 좀 더 관장된다. |
| @since | 작성 날짜 |
| @see | 외부 링크같은 것을 표시할 때 사용한다. 보통 <a href="링크 주소">링크링크</a> 태그와 같이 붙여서 사용한다. |
- 아래는 기본적인 태그를 활용하여 작성한 문서주석이다.
/**
* 입력받은 문자가 숫자인지 체크한다
*
* @param strNum 분석할 문자열
* @return double 타입으로 변환하여 반환
* @throws BadInputException 잘못된 숫자 입력
* @author 홍길동
*/
public static double ParserNumber(String strNum) throws BadInputException {
if (Pattern.matches(NUMBER_REG, strNum)) {
return Double.parseDouble(strNum);
} else {
throw new BadInputException("숫자");
}
}요렇게 작성하면 좋은점이 JavaDoc툴을 사용했을때 문서화되는 것도 있는데 선언부까지 갈필요 없이 사용한곳에 가서 마우스를 올려두면
이렇게 밑에 아까 작성한 주석이 주르륵 나온다. 다른 사람이 짠 코드를 읽거나 시간이 흐른뒤 유지보수할 때 시간을 훨씬 단축할 수 있다.
