javadoc 주석문 사용 예


    /**

     * setPattern(int data1, int data2)

     * 

     * @param data1 : data index

     * @param data2 : data length

     */

    private void setPattern(int data1, int data2)


클래스나 메소드 위에 '/** */' 과 같은 표시가 있어야 한다.

주석문 앞에 항상 '*' 마크가 있어야 한다.

주석이 html 형태로 생성되기 때문에 태그 사용이 가능하다.


@author 개발자

@exception 메소드에서의 예외 확인

@param 메소드의 매개변수

@return 메소드의 반환값

@see 다른 주제에 관한 링크 지정

@serial 직렬화 필드

@since 릴리즈 기록

@throws 메소드에서의 예외

@version 클래스의 버전


자세한 정보 : http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html


'programmer > android' 카테고리의 다른 글

GridView dynamic height  (0) 2014.04.29
Sms receive & scan  (0) 2013.10.03
listview animation  (0) 2013.07.25
Using fragment  (0) 2013.07.25
Adapter를 사용하는 View(ListView, GridView)에 Context menu 사용하기  (0) 2013.07.25

+ Recent posts