Egloos 728x90

구글 애널리틱스


2009/05/04 15:22

[ Java ] javadoc(API 문서) 작성 ▷ Java 복습



* API 문서작성 주석문
※ '@태그'를 사용한다.
@author : 클래스나 인터페이스의 제작자 표시
@version : 버전정보
@return : 메소드가 void형이 아닌경우 return value type을 기술
@exception : 메소드가 발생 시킬수 있는 예외를 기술
@throws : @exception Tag와 동일
@deprecated : 다음버전에서 폐기된 메소드를 알림
@param : 매개변수에 대한 설명(@param 변수 설명의 형태)
@serial : 기본적으로 직렬화 할 수 있는 클래스의 멤버를 설명
@see : 어떤 클래스 , 인터페이스,메소드, 생성자 혹은 URL에 대한 전후참조표시
@since : Tag를 가진 객체가 언제 추가 되었는지 명시

* API 문서작성법
javadoc -d . 소스파일.java

* 예제

/**
* 자바 API문서 만들기 예제 소스

* @author 별소리
* @version 1.0
*  
*/

public class JavaDocTest
{
 /** 기본 생성자
 */
 public JavaDocTest()
 {
  //내용 없는 기본 생성자
 }


 /** 메서드입니다. 단순히 문자열을 프린트합니다.
 */
 public void printTest()
 {
  System.out.println("Hello World!");
 }


 /** 실행 main 메서드
 */

 public static void main(String[] args)
 {
  new JavaDocTest().printTest();
 }
}



이를 [ javadoc -d . JavaDocTest.java ]로 컴파일하면...

이런 식으로 익숙한 형태의 API 문서가 만들어집니다.

덧글

댓글 입력 영역

애드센스336x280

알라딘TTB-Egloos(하단-일반)



이 이글루를 링크한 사람 (블랙)

36