[Android Studio] Javadoc 설정

JavaDoc 이란?

• JavaDoc이란 

Java Document의 줄임말로 자바 문서이다. JavaDoc은 자바에서 제공하는 클래스와 메소드를 문서화 하며 API 문서를 제작할 수 있다. 

• JavaDoc Annotation

@author : 제작자(문서 또는 클래스 상에 표기 )

@version : 버전

@exception : 메소드의 예외 기술

@throws : 예외 Throws 기술

@deprecated : 다음버전에 지원하지 않는 메소드 알림

@param : 메소드 파라미터 기술

@return : 리턴 타입 기술 ( void 이외에 리턴타입이 존재할 때 작성 )

@serial : 기본적으로 직렬화 할 수 있는 클래스의 멤버를 설명

@see : 클래스나 인터페이스, 메소드, 생성자 혹은 URL에 대한 전후 참조 표시

@since : Tag들이 언제 추가되었는지 기술

Android Stuido에서 JavaDoc 보기 설정하기

( ※ Android Studio에서는 Javadoc 보기가 기본설정이 되어 있지 않다. )

• File - Setting

• Editor - General - Show quick doc on mouse move 

 Doc 작성하기 

생성된 메소드위에 /**를 입력하면 파라미터와 리턴타입을 자동을 생성하고 아래와 같이 설명을 작성하여 완료한다.

아래와 같이 Annotation Tag들에 대하여 아래와 같이 마우스 오버를 하면 해당 메소드나 클래스에 대한 JavaDoc 정보들을 확인 할 수 있다. 

/**
 * Doc Test 입니다.
 * @param test01 파라미터 설명 01
 * @param test02 파라미터 설명 03
 * @param test03 파라미터 설명 03
 * @turn 리턴 설명
 */

안드로이드 스튜디오에서 JavaDoc Generate 하기

• Tool - Generate JavaDoc

해당 메뉴를 선택하며 Generate JavaDoc scope 항목에 범위를 설정한다. (프로젝트 전체, 모듈 앱, File 이 기본 선택이며 Custom scope를 통해 자신이 필요한 범위를 설정한다.)

Output directory: 를 통해 JavaDoc을 생성하기 원하는 디렉토리 위치를 설정한다.

Tag범위 등을 설정하고 

Other command line arguments:란에  -encoding UTF-8 -charset UTF-8 -docencoding UTF-8   과 같이 인코딩 프로젝트 설정을 해주어야 Generating 중에 오류가 나지 않을 것이다. 

완료가 되면 지정한 디렉토리에 패키지 명의 폴더와 JavaDoc 파일 (Html)이 생성된다.