이 마법사를 사용하여 Javadoc 생성을 생성할 수 있습니다. 이것은 Java JDK에서 사용 가능한 javadoc.exe 도구의 사용자 인터페이스입니다. Javadoc 도구에 대한 전체 문서를 보려면 Sun's Javadoc Tool 페이지를 방문하십시오.
유형 선택사항:
옵션 |
설명 |
---|---|
Javadoc를 생성할 유형 선택 |
목록에서 상자를 선택하거나 선택을 취소해서 JAR 파일로 내보낼 유형을 정확히 지정하십시오. 이 목록은 Workbench 선택사항으로 초기화됩니다. Javadoc 도구를 실행할 때 한 번에 하나의 프로젝트 클래스 경로만 사용할 수 있으므로 한 번에 한 개의 프로젝트만 선택할 수 있습니다. |
볼 수 있는 구성원에 대한 Javadoc 작성 |
|
표준 Doclet 사용 |
표준 doclet(기본값)로 Javadoc 명령을 시작합니다.
|
사용자 정의 Doclet 사용 |
사용자 정의 doclet를 사용하여 문서를 생성합니다.
|
표준 Doclet 인수(표준 doclet 사용이 선택되어 있을 때 사용 가능)
옵션 |
설명 |
---|---|
문서 제목 |
문서 제목을 지정합니다. |
사용 페이지 생성 | 문서에 사용 페이지를 포함하려는 경우 이 옵션을 선택하십시오. |
계층 구조 트리 생성 | 문서에 트리 페이지를 포함하려는 경우 이 옵션을 선택하십시오. |
네비게이터 표시줄 생성 |
문서에 탐색줄(헤더 및 바닥글)을 포함하려는 경우 이 옵션을 선택하십시오. |
색인 생성 | 문서에 색인 페이지를 포함하려는 경우 이 옵션을 선택하십시오. |
문자마다 색인 생성 | 문자마다 색인을 작성합니다. 색인 생성이 선택되어 있을 때 사용할 수 있습니다. |
@author | @author 태그를 문서화하려는 경우 이 옵션을 선택하십시오. |
@version | @version 태그를 문서화하려는 경우 이 옵션을 선택하십시오. |
@deprecated | @deprecated 태그를 문서화하려는 경우 이 옵션을 선택하십시오. |
거부된 목록 | 문서에 거부된 페이지를 포함하려는 경우 이 옵션을 선택하십시오. @deprecated 옵션이 선택되어 있을 때 사용할 수 있습니다. |
Javadoc가 링크를 작성할 참조 클래스 선택 |
다른 유형이 참조될 때 Javadoc가 링크를 작성해야 하는 다른 문서를 지정하십시오.
|
스타일시트 | 사용할 스타일시트 선택 |
일반 Javadoc 옵션:
옵션 |
설명 |
---|---|
개요 |
Javadoc가 지정된 파일에서 개요 문서의 텍스트를 검색해야 함을 지정합니다. 이것은 overview-summary.html에 둡니다. |
추가 Javadoc 옵션 |
여기에 여러 개의 추가 옵션(사용자 정의 doclet 옵션, VM 옵션 또는 JRE 1.4 호환성 옵션)을 추가합니다. |
이 Javadoc를 Ant 스크립트로 내보내기 설정 저장 |
마법사를 사용할 필요없이 지정된 Javadoc 내보내기를 수행할 Ant 스크립트를 저장하도록 지정합니다. 기존의 Ant 스크립트는 이 마법사를 사용하여 수정할 수 있습니다(생성된 Ant 스크립트의 컨텍스트 메뉴에서 Javadoc 마법사 열기 사용). |
브라우저에서 생성된 색인 파일 열기 | 생성된 index.html 파일을 브라우저에서 엽니다(표준 doclet를 사용할 때만 사용 가능). |
완료를 눌러 Javadoc 생성을 시작하십시오. 대상이 프로젝트의 Javadoc 위치 페이지를 구성한 위치와 다른 경우 프로젝트의 Javadoc 위치를 새 대상 폴더로 설정할지 묻습니다. 그렇게 하면 외부 Javadoc 열기의 모든 호출이 지금 작성한 문서를 사용합니다.
새 프로세스가 시작되고 배경에서 생성이 수행됩니다. 콘솔 보기(창 > 보기 표시 > 콘솔)를 열어 생성 진행 및 상태를 확인하십시오.