Eclipse Javadoc

Javadoc은 축약해서 말하자면 프로그래머들의 의사소통이라고 할 수 있습니다.
너무 난해한 표현인가요? 
그럼 예로 들어서 여러분이 Java 프로그래밍을 할 때 참고하는 JAVA API도 Javadoc입니다.

그 외에도 자바를 활용하여 만든 수많은 결과물(Spring, Vert.X...)들도 API문서를 제공합니다.
이러한 API에는 트리구조로 작성되어, 패키지 -> 클래스 -> 메소드 순서로 확인이 가능합니다.
API 문서가 존재하지 않는다면 작성되어 배포되는 클래스와 메소드의 쓰임새를 알 수 없겠지요.

평소에 작성하는 주석들이 모여서 Javadoc이 만들어집니다.
따라서 주석을 보기좋게 작성하는 습관을 길러야 겠습니다.
주석을 쉽게 작성하는 방법은 이클립스에서 Shift+Alt+J 키를 누르면 기본 템플릿 주석이 만들어집니다.
템플릿은 개발자들의 환경에 맞게 셋팅할 수 있습니다.

[Window] - [Preferences] - [Java] - [Code Style] - [Code Template] - [Comments]
Types (Class), Fields (변수), Constructors(생성자), Methods(메소드)...
수정하고자 하는 항목을 클릭하신 후, Edit 버튼을 눌러 수정할 수 있습니다.

하단의 예제 주석문은 전자정부프레임워크의 EgovSampleController 에서 발췌한 코드입니다.

Class(Type) 주석

/**
 * @Class Name : EgovSampleController.java
 * @Description : EgovSample Controller Class
 * @Modification Information
 * @
 * @  수정일      수정자              수정내용
 * @ ---------   ---------   -------------------------------
 * @ 2009.03.16           최초생성
 *
 * @author 개발프레임웍크 실행환경 개발팀
 * @since 2009. 03.16
 * @version 1.0
 * @see
 *
 */

Method 주석

/**
	 * 글을 조회한다.
	 * @param sampleVO - 조회할 정보가 담긴 VO
	 * @param searchVO - 목록 조회조건 정보가 담긴 VO
	 * @param status
	 * @return @ModelAttribute("sampleVO") - 조회한 정보
	 * @exception Exception
	 */

Field 주석

/** EgovSampleService */
	@Resource(name = "sampleService")
	private EgovSampleService sampleService;

	/** EgovPropertyService */
	@Resource(name = "propertiesService")
	protected EgovPropertyService propertiesService;

	/** Validator */
	@Resource(name = "beanValidator")
	protected DefaultBeanValidator beanValidator;