Javadoc 문법

[Javadoc export]

Java document 를 만들 프로젝트의 우측클릭해서

export 클릭.

Javadoc 빌더를 찾으라는 데, 경로를 지정해주자.

자바가 설치된 폴더에서 #JAVA_HOME/bin/javadoc.exe 를 선택.

Javadoc이 저장 될 경로를 지정해주면 끝이 난다.

[Javadoc 주석 문법]

Javadoc의 문법은 개발자가 달아놓은 주석을 바탕으로 인지하는 데,

일반적인 /* ~ ~ ~ */  의 주석이 아니라

/** ~ ~ ~ */ 주석의 형태를 인식한다.

단축키 : 알트 + 쉬프트 + J // 

(그런데 이거보다 이클립스에서 주석을 달 메소드나 클래스 위에서

/**  입력후 엔터치면 알아서 자동완성 된다.. 이게 더 편하다.)

[주석 형태]

1. 기본적인

/**

* 설명메시지작성

*/

2. return 이 있을 경우

/**

* 설명메시지작성

* @return return에 대한 메시지 작성

*/

3. parameter 가 있을 경우

/**

* 함수설명메시지작성

* @param param에 대한 메시지 작성

*/

[태그 형태]

@param : 파라미터에 대한 설명

@return : 리턴 값에 대한 설명

@throws : 예외 에 대한 설명

@author : 코드 제작자

@deprecated : 이 코드를 추천 하지는 않을 때..

@see : 참조되거나 관련있는 개체 표시

@version : 코드의 버전 정보

@since : 코드가 적용된 버전 정보

만약에 예제로 보여주고 싶은 코드가 있다면, 

이 코드를 평문으로 작성해야할 것이다. 이럴 때에는 code 태그를 쓰면 된다.

<code>예제 코드</code>