Javadoc란

[출처 : http://ethdemor.springnote.com/pages/4348417]

하나 이상의 Package에  있는 수많은 클래스와 인터페이스로 구성된
API를 설명한다.
클래스와 인터페이스 자체와 각 클래스의 public 메소드와 필드들로  
  Application을 문서화 하는것을 포함한다.
또한 사용자들에게 클래스의 private이나 protected 멤버들에 대한  
  정보를 공개하지 않으면서 이들에 대한 javadoc 주석을 포함할수 있다.
문서의 주석은 /** 로 시작하며 */로 끝난다.
각 라인은 하나 이상의 *로 시작한다.(공백줄 포함)
주석내에는 html을 포함할수 있다.(<  <, > >, &  &)


@author : 클래스나 인터페이스의 제작자 표시
@version : 버전정보
@return : 메소드가 void형이 아닌경우 return value type을 기술
@exception : 메소드가 발생 시킬수 있는 예외를 기술
@throws : @exception Tag와 동일
@deprecated : 다음버젼에서 폐기된 메소드를 알림
@param : 매개변수에 대한 설명(@param 변수 설명의 형태)
@serial : 기본적으로 직렬화 할 수 있는 클래스의 멤버를 설명
@see : 어떤 클래스 , 인터페이스,메소드, 생성자 혹은 URL에 대한 전후참조표시
    @see 클래스이름, @see 클래스의 완전한이름,@see 클래스완전하이름#메소드
@since : Tag를 가진 객체가 언제 추가 되었는지 명시
{@link #entity label} : 메소드나 필드의 상호 참조에 대한 링크를 표시
                   @see와 다른 점은 link를 쓸경우 문서텍스트안에 링크가 생기는데
                     반해 @see는 분리된 줄에 링크를 만든다.
{@doc-root} : 문서에 대해 루트디렉토리에 대한 상대경로 지정

Tag 이름은 대소문자를 구분한다.
클래스와 인터페이스의 주석에는 다음의 Tag가 포함 가능하다.
  @author,@version,@since,@deprecated,@see
메소드와 관련된 주석에는 다음의 Tag가 포함 가능하다.
  @throws,@exception,@param,@return,@serialData
  - @serialData의 경우 기본적으로 직렬화 되지 않지만
      witeObject(),readObject(),writeExternal(),readExternal()
      등으로 읽거나 쓸수있는 항목을 설명


        
/**
* <B>CowboyHat Class</B>는  모자에 대한 class member를 정의 한 클래스 입니다..
* 각각의 메소드는 다음과 같습니다.  
* 모자를 쓰는 {@link #putHatOn() putHatOn()}, 모자를 벗는 {@link #takeHatOff() takeHatOff()},
* , Owner를 바꾸는 {@link #changeOwner(String) changeOwner(String newOwner)},
* 그리고 모자의 size를 얻는 {@link #getSize() getSize()} 등의 메소드가 정의되어 있습니다.
*
* @author jclee
* @version 2.0 Jan 2002
*
* @see <a href="./cowboy.html">소스코드</a>
* @see #owner
* @see #changeOwner(String)
*/
public class CowboyHat {    

            //instance variable
public String owner;
private String type;
private int size;
private boolean hatOn=false;

   /**
   * Constructor to create CowboyHat Object
   */
public CowboyHat(String anOwner, String aType, int aSize) {
size = aSize;
type = aType;
owner = anOwner;
}

            /**
* method to put the hat on
*/
public void putHatOn() {
hatOn = true;
}

/**
* method to take the hat off
*/
public void takeHatOff() {
hatOn = false;
}

            /**  
* mathod to change the owner name
* @param newOwner 변경하고자 하는 새로운 Owner명을 parameter로 한다.
* @return return되는 값은 없습니다.
*/
public void changeOwner(String newOwner) {
owner = newOwner;
}

/**  
* method to get hat size
*/
public int getSize() { return size;}
}
실행방법>D:자바프로그래밍예제>mkdir doc
       D:자바프로그래밍예제>javadoc -d doc CowboyHat.java

[출처 : http://ethdemor.springnote.com/pages/4348417]