이클립스 javadoc code templates
- JAVADOC 생성하기
Project > generate javadoc.. 클릭
javadoc command : JDK설치프로젝트의 bin > javadoc.exe 를 찾아서 경로 등록 (다른 javadoc command도 있나보다)
바로 finish해도 되지만.. 한글이 깨지는현상이 생긴다.
next > next 한뒤,
VM options에 아래내용을 등록 해주자(따옴표는 빼고 ㅋ)
"-locale ko_KR -encoding UTF-8 -charset UTF-8 -docencoding UTF-8"
- 코드템플릿 수정하기
window > preferences > Java > Appearance >
Build Path > CodeStyle > Code Templates > Comments
xml파일을 import할수도 있음
140207_codetemplates.xml실제 javadoc에 표시될때 간략한내용에는 메서드나 변수 설명이 한줄만 간단하게 표시되고,
메서드를 클릭했을때 상세하게 설명해놓은 부분에는,
간단한설명 + 내용, 예제, 인자 등 설명이 되는데 첫 콤마를 기준으로 분리를 하는것 같다. (다른식별자가 있을듯 한데.. 못찾겠다 ㅎ )
<pre>는 html태그. 줄바꿈신경 안쓰기 위한..
- Files 내용 : 파일에는 기록되지만 javadoc에는 반영 안되는듯 하다.
/**
* 0. Project : XXXX 프로젝트
*
* 1. FileName : ${file_name}
* 2. Package : ${package_name}
* 3. Comment :
* 4. 작성자 : ${user}
* 5. 작성일 : ${date} ${time}
* 6. 변경이력 :
* 이름 : 일자 : 근거자료 : 변경내용
* ------------------------------------------------------
* ${user} : ${date} : : 신규 개발.
*/
- Types 내용 : class전체에 대한 설명
/**
* <pre>
* 간략 : .
* 상세 : .
* ${package_name}
* |_ ${file_name}
* </pre>
*
* @Company : DGIST
* @Author : ${user}
* @Date : ${date} ${time}
* @Version : 1.0
*/
- Fields 내용 : 맴버변수에 대한 설명
/**
*
*/
- Constructors 내용 : 생성자에 대한 설명
/**
* <PRE>
* 간략 : .
* 상세 : .
* <PRE>
* Constructor of ${file_name} class 생성자
* ${tags}
*/
- Methods 내용 : 메서드에 대한 설명
/**
* <PRE>
* 간략 : .
* 상세 : .
* <PRE>
* ${tags}
*/
- Overriding methods 내용 : 부모클래스로부터 상속받은 메서드에 대한 설명 (마지막줄에 see를 붙였음)
/**
* <PRE>
* 간략 : .
* 상세 : .
* <PRE>
* ${see_to_overridden}
*/
- Delegate methods 내용 : 어디쓰는지 잘 모르겠음.. 아직 본적없음
/**
*/
- Getters 내용 :
/**
* Comment :
* @return the ${bare_field_name}
*/
- Setters 내용 :
/**
* Comment :
* @param ${param} the ${bare_field_name} to set
*/
=====================================================================================
위의 템플릿으로 생성해본 javadoc
