Javadoc 생성 

 


당신의 프로젝트에서 Javadoc 자동적으로 생성하기 위해, Tools |  Generate JavaDoc  메뉴 항목을 선택하십시오.

다음 패널이 열릴 것입니다:

전체 프로젝트

만일 당신이 전체 프로젝트를 위해 생성된 Javadoc 필요하면 옵션 버튼을 선택하십시오.
만일 당신이 Project View에서 어느 특정의 패키지도 선택하지 않으면 그것은 디폴트로 확인됩니다.

패키지 'package_name'

만일 Javadoc 특별한 패키지에서 생성될 것이라면 옵션 버튼을 선택하십시오.

특정의 패키지가 Project View에서 선택되던가, 또는 만일 초점이 에디터에 있으면 그것은 디폴트로 확인됩니다.  만일 Include subpackages  옵션이 체크되면 Javadoc 선택된 것의 내부의 패키지를 위해 생성됩니다.

출력 디렉터리

생성된 문서화가 저장될 것인 디렉터리에 패스를 지정하십시오.  경로를 수동으로 입력하거나, ellipsis 버튼의 도움으로 열릴 있는 Select Path 다이얼로그에서 그것을 선택합니다.   필드로부터의 데이터는 Javadoc's -d  매개변수로 전해질 것입니다


만일 정의된 디렉터리가 당신의 시스템의 안에 존재하지 않으면, IDEA 의해 그것을 생성하기 위해 당신에게 프롬프트   것입니다.

범위


슬라이더의 도움으로, 클래스와 구성 요소에서 생성된 문서화로 어느 것을 포함해야 하는지 지정하십시오:

private

-private Javadoc 매개변수에 대응합니다; 선택되면, 모든 클래스와 멤버를 포함합니다.

package

-package Javadoc 매개변수에 대응합니다; 선택되면, 개인적인 것을 제외하고 모든 클래스와 멤버를 포함합니다.

protected

-protected Javadoc 매개변수에 대응합니다; 선택되면, 오로지 퍼블릭과 보호된 클래스와 멤버 만을 포함합니다.

public

-public Javadoc 매개변수에 대응합니다; 선택되면, 오로지 퍼블릭 클래스와 멤버 만을 포함합니다.

기본 옵션


Javadoc
생성을 위해 기본 옵션을 포함합니다.   체크 박스는 a Javadoc  매개변수에 부합합니다: 

Generate hierarchy tree  

클래스 계층의 스위치 생성 체크 박스가 선택되지 않을 , -notree 매개 변수는 Javadoc  넘겨집니다.

Generate navigator bar  

네비게이터 바의 스위치 생성 체크 박스가 선택되지 않을 , -nonavbar 매개 변수는 Javadoc  넘겨집니다.

Generate index  

문서화 인덱스의 스위치 생성 체크 박스가 선택되지 않을 , -noindex 매개 변수는 Javadoc  넘겨집니다.

Separate index per letter  

만일 Generate index 선택되면 사용 가능합니다; 문자를 위해 별도 색인 파일을 생성합니다선택되면 -splitindex  매개변수는 Javadoc 넘겨집니다.

태그를 문서화

생성된 문서화로 포함된 Javadoc 부가적 부분을 지정하십시오.   체크 박스는 Javadoc 매개변수에 일치합니다.

@use   

문서 클래스와 패키지 사용선택되면, -use Javadoc 매개변수에 일치합니다.

@author  

@author 패러그래프를 포함합니다; 선택되면, -author Javadoc 매개변수에 일치합니다.

@version 

@version패러그래프를 포함합니다; 선택되면, -author Javadoc 매개변수에 일치합니다.

@deprecated  

@deprecated 정보를 포함합니다; 만일 선택되지 않으면, -nodeprecated 매개변수는 Javadoc

넘겨집니다.

deprecated list 

만일 @deprecated 선택되면 가능합니다; deprecated 목록이 생성됩니다; 만일 선택되지 않으면 –nodeprecatedlist 매개변수는 Javadoc 넘겨집니다.

다른 매개 변수

당신이 아마도 필요하지만 IDEA UI 에서 반영되지 않은 다른 Javadoc 매개변수를 지정하십시오.

최대 크기(Mb)

Javadoc 실행하기 위한 자바 VM 의해 사용될 최대 크기를 Mb단위로 지정하십시오

브라우저에서 생성된 문서 열기

만일 당신이 IDEA 브라우저에서 생성된 Javadoc 자동적으로 열기 바라면 체크 박스를 선택하십시오.


체크 박스를 선택할 , 당신의 브라우저로의 경로가 File | Settings: IDE Settings 다이얼로그,  General  다이얼로그 (applicable for Linux/Unix Mac OS 대해 적용할 있는)에서 정의되었는지 확인하십시오.