JAVADOC 기본 참고 자료

1. 세팅하기
 프로프레임 메뉴 : 창(W)-환경설정(P)
                      Java-코드 스타일-코드 템플리트
 새로작성시에는 [편집]버튼을 클릭하여 아래 내용들을 각각에 넣는다.
 만약 주석포맷 파일(xml)이 있으면 [가져오기]버튼 클릭하여 파일을 찾아 선택한다.
 
세팅 끝. 
(개인적으로 수정하실분은 [편집]버튼을 클릭하여 수정합니다.)
 
Shift + Alt + J

2. 주석 사용하기
클래스 생성시 생성 화면 맨 아래에 [주석생성] 체크 박스가 있습니다. 체크하고 [완료]버튼 클릭하면 파일주석이 생성됩니다.
 
클래스와 메소드주석은 클래스나 메소드명이 있는 라인에서 마우스 R-버튼 클릭 후 [소스]-[요소주석생성]을 클릭하면 주석이 자동 생성됩니다.

** 참고
   버전도 관리를 해야 하나 아직 미숙한 관계로 이번에는 주석에 버전항목을 작성하지 않는다.

 

 

===[파일주석(파일)]==================================================
/**
 * 0. Project  : XXXX 프로젝트
 *
 * 1. FileName : ${file_name}
 * 2. Package : ${package_name}
 * 3. Comment : 
 * 4. 작성자  : ${user}
 * 5. 작성일  : ${date} ${time}
 * 6. 변경이력 : 
 *                    이름     : 일자          : 근거자료   : 변경내용
 *                   ------------------------------------------------------
 *                    ${user} : ${date} :            : 신규 개발.
 */

===[Class주석(유형)]================================================== 
/**
 * <PRE>
 * 1. ClassName : ${enclosing_type}
 * 2. FileName  : ${file_name}
 * 3. Package  : ${package_name}
 * 4. Comment  : 
 * 5. 작성자   : ${user}
 * 6. 작성일   : ${date} ${time}
 * </PRE>
 */ 
 

===[생성자주석(생성자)]==================================================  
/**
 * <PRE>
 * 1. MethodName : ${enclosing_type}
 * 2. ClassName  : ${enclosing_type}
 * 3. Comment   : 
 * 4. 작성자    : ${user}
 * 5. 작성일    : ${date} ${time}
 * </PRE>
 *   ${tags}
 */ 
 

===[메소드주석(메소드)]==================================================
/**
 * <PRE>
 * 1. MethodName : ${enclosing_method}
 * 2. ClassName  : ${enclosing_type}
 * 3. Comment   : 
 * 4. 작성자    : ${user}
 * 5. 작성일    : ${date} ${time}
 * </PRE>
 *   @return ${return_type}
 *   ${tags}
 */
 

===[메소드대체주석(메소드대체)]================================================== 
/**
 * <PRE>
 * 1. MethodName : ${enclosing_method}
 * 2. ClassName  : ${enclosing_type}
 * 3. Comment   : 
 * 4. 작성자    : ${user}
 * 5. 작성일    : ${date} ${time}
 * </PRE>
 *   ${tags}
 */