1. 주석의 개념
- 코드에 대한 개요와 코드에 대한 부가설명 제공
- 프로그램을 읽는 것과 이해하는 것에 관한 정보만을 포함하고 있어야 함
- 중복된 주석은 피해야 함
- 주석을 추가해야만 할 정도의 프로그램이라면 재작성을 고려해야 함
- 특수문자를 포함하면 안됨
2. 주석 작성 방법
1) "/* */"에 의해 경계가 결정되는 것을 '구현 주석'이라 하는데, 개별적 구현에 대한 주석이며 코드와는 무관한 주석이다.
2) "/** */"에 의해 경계가 결정되는 것을 '문서 주석'이라 하는데, javadoc 툴을 이용하여 HTML파일로 축출한다.
* @date라는 자바독 주석은 없다. API문서화하는데 문제는 없지만 생성하는 중 경고가 생긴다.
* 메소드 위에 작성하는 문서 주석(/** */) 사이에 글만 써놓는다면 API문서에서 그 메소드에 대한 method summary로 볼 수 있다.
3. 블럭태그의 종류
@author 이름 |
클래스나 인터페이스의 제작자 표시 |
@version 테스트 |
클래스나 인터페이스에서의 버전 정보 |
@param 매개변수 - 이름 설명 |
매개 변수에 대한 설명 |
@return 설명 |
메소드가 void를 리턴하거나 생성자가 아닌 경우를 제외하고 모두 사용해야 함 |
@exception or @throws |
메소드가 발생시킬 수 있는 예외를 기술 |
@deprecated |
다음 버전에서 폐기된 메소드를 알림 |
@serial |
기본적으로 직렬화 할 수 있는 클래스의 멤버를 설명 |
@see |
- 어떤 클래스, 인터페이스, 메소드, 생성자 혹은 URL에 대한 전후 참조 표시 |
@since |
Tag를 가진 객체가 언제 추가되었는지 명시 |
{@link #entity label} |
메소드나 필드의 상호 참조에 대한 링크를 표시 |
{@doc-root} |
문서에 대한 루트디렉토리에 대한 상대경로 지정 |
/**
* Java doc 사용예
* @param number 숫자
* @return int 숫자의 합
* @ author 나사람
* @ version 1.0
*/
public int getNumber(int number)
{
return number+1;
}
* 참조 :
누즈의 웹 블로그(http://imnuz.net/entry/java-doc-%BB%E7%BF%EB%B9%FD)
자바를 통하여 세계로(http://cafe.naver.com/worldofjava/272)
What i do(http://astala.tistory.com/137)
'PROGRAMMING > JAVA' 카테고리의 다른 글
4. 상속(inheritance) (0) | 2013.02.25 |
---|---|
3. 배열(Array) (0) | 2013.02.25 |
2. 클래스 (0) | 2013.02.20 |
1. JAVA 기초 (2) | 2013.02.20 |
eclipse 자바독 API 만들기 (126) | 2012.12.21 |