Ant-ビルドドキュメント

ドキュメントは、どのプロジェクトでも必須です。ドキュメントは、プロジェクトのメンテナンスにおいて重要な役割を果たします。 Javaは、組み込みの javadoc ツールを使用してドキュメントを簡単にします。 Antは、必要に応じてドキュメントを生成することにより、さらに簡単にします。

ご存じのとおり、javadocツールは柔軟性が高く、多くの構成オプションを使用できます。 Antは、javadocタスクを介してこれらの構成オプションを公開します。 javadocsに慣れていない場合は、次のリンクから始めることをお勧めします：/java/java_documentation [Javaドキュメントチュートリアル]。

次のセクションでは、Antで使用される最も一般的に使用されるjavadocオプションをリストします。

属性

ソースは、 sourcepath 、 sourcepathref 、または sourcefiles を使用して指定できます。

sourcepath は、ソースファイルのフォルダーを指すために使用されます（例： srcフォルダー）。
sourcepathref は、path属性（デリゲート.src.dirなど）によって参照されるパスを参照するために使用されます。
sourcefiles は、個々のファイルをコンマ区切りリストとして指定する場合に使用されます。

宛先パスは、 destdir フォルダー（例：build.dir）を使用して指定されます。

含めるパッケージ名を指定することにより、 javadoc タスクをフィルタリングできます。これは、パッケージファイルのカンマ区切りリストである packagenames 属性を使用して実現されます。

javadocプロセスをフィルター処理して、パブリック、プライベート、パッケージ、または保護されたクラスとメンバーのみを表示できます。これは、 private 、 public 、 package 、および protected 属性を使用して実現されます。

また、javadocタスクに、それぞれの属性を使用して作成者とバージョンの情報を含めるように指示することもできます。

*group* 属性を使用してパッケージをグループ化して、ナビゲートしやすくすることもできます。

すべてを一緒に入れて

*Hello world* Faxアプリケーションのテーマを続けましょう。 FAXアプリケーションプロジェクトにドキュメントターゲットを追加しましょう。

以下に、プロジェクトで使用されるjavadocタスクの例を示します。この例では、ソースディレクトリとして src.dir を使用し、ターゲットとして doc を使用するようにjavadocを指定しています。

また、Javaドキュメンテーションページに表示されるウィンドウタイトル、ヘッダー、およびフッター情報をカスタマイズしました。

また、我々は3つのグループを作成しました-

ソースフォルダー内のユーティリティクラス用
ユーザーインターフェイスクラス用
データベース関連のクラス用です。

データパッケージグループには、faxapp.entityとfaxapp.daoの2つのパッケージがあります。

<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ターゲット*が実行されると、次の結果が生成されます-

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

java doc has been generated!

BUILD SUCCESSFUL
Total time: 10.63 second

これで、Javaドキュメントファイルが doc フォルダーに存在します。

通常、javadocファイルはリリースまたはパッケージターゲットの一部として生成されます。

Ant-build-documentation

Ant-ビルドドキュメント

属性

すべてを一緒に入れて