이클립스 자동 주석 및 JAVADOC 출력

#이클립스 자동 주석 달기

펌 - http://zzznara2.tistory.com/75

Window > Preferences > Java > Code Style > Code Templates 클릭

Comments > Types,Methods 작성 

ex)

/*

 * 

 * @author : ${user}

 * @since   : ${date}

 * ${tags}

*/

#JAVADOC에 맞추어 주석달기

펌 - http://arihong218.tistory.com/entry/JavaDoc%EC%9D%84-%EC%93%B0%EA%B8%B0-%EC%9C%84%ED%95%9C-%EC%A3%BC%EC%84%9D%EB%8B%AC%EA%B8%B0-%EB%B0%A9%EB%B2%95

3. 블럭태그의 종류

@author 이름	클래스나 인터페이스의 제작자 표시
@version 테스트	클래스나 인터페이스에서의 버전 정보
@param 매개변수 - 이름 설명	매개 변수에 대한 설명
@return 설명	메소드가 void를 리턴하거나 생성자가 아닌 경우를 제외하고 모두 사용해야 함
@exception or @throws	메소드가 발생시킬 수 있는 예외를 기술
@deprecated	다음 버전에서 폐기된 메소드를 알림
@serial	기본적으로 직렬화 할 수 있는 클래스의 멤버를 설명
@see	- 어떤 클래스, 인터페이스, 메소드, 생성자 혹은 URL에 대한 전후 참조 표시  - 분리된 줄에 링크가 생김
@since	Tag를 가진 객체가 언제 추가되었는지 명시
{@link #entity label}	메소드나 필드의 상호 참조에 대한 링크를 표시 문서 텍스트 안에 링크가 생김
{@doc-root}	문서에 대한 루트디렉토리에 대한 상대경로 지정

#JAVADOC EXPORT

펌 - http://hbesthee.tistory.com/1380

아래 그림을 따라 진행하면 JAVADOC 문서를 출력할 수 있다.

1. JDK가 설치된 폴더에서 javadoc.exe를 찾아 선택합니다.
2. javadoc을 생성할 패키지 전체를 선택합니다.
3. javadoc을 만들 범위를 선택합니다.(저는 package 단계까지 생성되도록 하였습니다.)
4. javadoc이 만들어질 위치를 선택합니다.
5. 모든 설정이 끝났으면 "Finish"를 눌러서 javadoc을 생성합니다.

Project 메뉴의 Javadoc을 생성하는 설정창도 위와 동일한 창이였는데... 안되었던 이유는 단지 아래와 같이 패키지 전체가 선택되지 않았기 때문이었습니다.

위 그림의 LA 패키지 선택 체크 박스가 회색으로 모든 파일이 선택된 것이 아니라, 현재 프로젝트에서 활성화된 소스만 선택되어 있고 결국 활성화된 소스만 javadoc으로 만들어졌었던 겁니다. ^^;

Eclipse에서 javadoc 생성을 하려는데 
아래와 같은 에러가 났습니다.

javadoc unmappable character for encoding MS949

코드의 주석에 한글(UTF-8로 인코딩된)을 써서 그런 것 같아 구글링 해봤더니 역시나 그 문제 였네요.

해결 방법은 아래 창이 나타났을 때
VM options에 

-encoding UTF-8

을 적어주면 해결 됩니다.
그러면 한글이 포함된 JavaDoc을 생성할 수 있습니다.