Ant-빌드 문서

문서는 모든 프로젝트에서 필수입니다. 문서화는 프로젝트 유지 관리에 큰 역할을합니다. Java는 내장 된javadoc수단. Ant는 필요에 따라 문서를 생성하여 훨씬 쉽게 만듭니다.

아시다시피 javadoc 도구는 매우 유연하며 다양한 구성 옵션을 허용합니다. Ant는 javadoc 태스크를 통해 이러한 구성 옵션을 노출합니다. javadocs에 익숙하지 않은 경우이 Java Documentation Tutorial로 시작하는 것이 좋습니다 .

다음 섹션은 Ant에서 사용되는 가장 일반적으로 사용되는 javadoc 옵션을 나열합니다.

속성

소스는 다음을 사용하여 지정할 수 있습니다. sourcepath, sourcepathref 또는 sourcefiles.

sourcepath 소스 파일 (예 : src 폴더)의 폴더를 가리키는 데 사용됩니다.
sourcepathref 경로 속성 (예 : delegates.src.dir)에서 참조하는 경로를 참조하는 데 사용됩니다.
sourcefiles 개별 파일을 쉼표로 구분 된 목록으로 지정하려는 경우 사용됩니다.

대상 경로는 destdir 폴더 (예 : build.dir).

당신은 필터링 할 수 있습니다 javadoc포함 할 패키지 이름을 지정하여 작업. 이것은packagenames 속성, 쉼표로 구분 된 패키지 파일 목록입니다.

공용, 개인, 패키지 또는 보호 된 클래스와 멤버 만 표시하도록 javadoc 프로세스를 필터링 할 수 있습니다. 이것은private, public, package 과 protected 속성.

각 속성을 사용하여 작성자 및 버전 정보를 포함하도록 javadoc 태스크에 지시 할 수도 있습니다.

다음을 사용하여 패키지를 함께 그룹화 할 수도 있습니다. group 탐색이 쉬워집니다.

함께 모아서

우리의 주제를 계속합시다 Hello world팩스 신청. 팩스 애플리케이션 프로젝트에 문서 대상을 추가하겠습니다.

다음은 프로젝트에서 사용 된 javadoc 작업의 예입니다. 이 예에서는 다음을 사용하도록 javadoc을 지정했습니다.src.dir 소스 디렉토리로 doc 목표로.

또한 Java 문서 페이지에 나타나는 창 제목, 머리글 및 바닥 글 정보를 사용자 지정했습니다.

또한 세 그룹을 만들었습니다.

하나는 소스 폴더의 유틸리티 클래스 용입니다.
하나는 사용자 인터페이스 클래스 용입니다.
하나는 데이터베이스 관련 클래스 용입니다.

데이터 패키지 그룹에 faxapp.entity 및 faxapp.dao 패키지가 있음을 알 수 있습니다.

<target name = "generate-javadoc">
   <javadoc packagenames = "faxapp.*" sourcepath = "${src.dir}" 
      destdir = "doc" version = "true" windowtitle = "Fax Application">
      
      <doctitle><![CDATA[= Fax Application =]]></doctitle>
      
      <bottom>
         <![CDATA[Copyright © 2011. All Rights Reserved.]]>
      </bottom>
      
      <group title = "util packages" packages = "faxapp.util.*"/>
      <group title = "web packages" packages = "faxapp.web.*"/>
      <group title = "data packages" packages = "faxapp.entity.*:faxapp.dao.*"/>
   </javadoc>

   <echo message = "java doc has been generated!" />
</target>

javadoc Ant 태스크를 실행 해 보겠습니다. Java 문서 파일을 생성하고 doc 폴더에 배치합니다.

때 javadoc target 실행되면 다음과 같은 결과가 생성됩니다.

C:\>ant generate-javadoc
Buildfile: C:\build.xml

java doc has been generated!

BUILD SUCCESSFUL
Total time: 10.63 second

Java 문서 파일은 이제 doc 폴더.

일반적으로 javadoc 파일은 릴리스 또는 패키지 대상의 일부로 생성됩니다.