Javadoc 만들기 | 주석 서식 | 필드에 대한 주석 작성 시에 주의점
Java에서는 동일한 데이터 형식의 여러 필드를 한 번에 선언 할 수 있다.
int width, height;
이런 형식에 대해서 주석을 작성하게 되면 다음과 같이 작성이 될것이다.
/**
* 폭과 높이를 나타낸다.
*/
int width, height;
이 경우는 두 변수에 같은 주석이 적용된다. 결과적으로 다음과 같이 작성했을 경우와 동일하다.
/**
* 폭과 높이를 나타낸다.
*/
int width;
/**
* 폭과 높이를 나타낸다.
*/
int height;
경우에 따라서는 이러한 형식으로도 문제없는 경우도 있겠지만, 대부분의 경우는 적절한 주석가 되지 않는다. 그러기에 Javadoc를 이용하는 경우에는 필드마다 선언하고, 별도의 주석을 하도록 한다.
쌤플
간단한 예제를 실습해 보도록 하자.
/**
* Javadoc 테스트용 클래스
*/
public class Sample04 {
/**
* 폭과 높이를 나타낸다.
*/
public int width, height;
/**
* 사이즈 설정
*
* @param width 폭
* @param height 높이
*/
public void setSize(int width, int height) {
}
}
위에 소스 코드를 “Sample04.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.
$ javadoc -d doc Sample04.java
“doc"디렉토리에 있는 “Sample04.html” 파일을 브라우저로 확인해 보자.
여러 필드가 한 번에 선언되어 한개의 주석을 작성하게 되면, 각각의 필드에 같은 주석이 표시된다.