みやびの爽臭サプリ

[Java] Antを使ったJavaDoc作成方法

Antを使ってJavaDocをサクッと作ってしまう方法です。作業前に、Java環境をインストールしておくことが必須です。

スポンサーリンク

Antのダウンロード

Windows用のAntをダウンロードします。

Antをインストール

ダウンロードしたZIP書庫を、任意の場所に解凍します。

[例] c:\apache-ant-1.7.0

環境変数の設定

パスを通すため、Windowsの環境変数を設定します。

  • Path に c:\apache-ant-1.7.0\bin を追加
  • ANT_HOME を新規作成し、c:\apache-ant-1.7.0 を設定

build.xmlを作成

JavaDocを作成するプロジェクトのbuild.xmlを作成します。以下、サンプルなので、フォルダ構成等は環境に合わせて書き換えてください。

<?xml version="1.0" encoding="UTF-8"?>
<project default="javadoc">
<target name="javadoc">
<javadoc access="private" additionalparam="-source 6.0" author="true" 
	classpath="../achievementEjb/lib/toplink-essentials.jar;
	           ../achievementEjb/build/classes;
	           ../JavaCommon_achievement/lib/javaee.jar;
	           ../JavaCommon_achievement/lib/java-common-web.jar;
	           ../JavaCommon_achievement/lib/java-common-lang.jar;
	           ../JavaCommon_achievement/lib/java-common-jsf.jar;
	           ../JavaCommon_achievement/lib/java-common-file.jar;
	           ../JavaCommon_achievement/lib/java-common-parameter.jar;
	           ../JavaCommon_achievement/lib/java-common-log.jar"
	destdir="javadoc"
	doctitle="〇〇管理システム"
	packagenames="jp.co.company.ops.entity.candy,
	              jp.co.company.ops.entity.casa,
	              jp.co.company.ops.session.partner_results,
	              jp.co.company.ops.session.partner_results.bw_color,
	              jp.co.company.ops.session.partner_results.other,
	              jp.co.company.ops.session.partner_results.product,
	              jp.co.company.ops.common.bw_color,
	              jp.co.company.ops.common.product,
	              jp.co.company.ops.enums,
	              jp.co.company.ops.exception,
	              jp.co.company.ops.common,
	              jp.co.company.ops.common.enums,
	              jp.co.company.ops.filter,
	              jp.co.company.ops.form,
	              jp.co.company.ops.tag" 
	sourcepath="src;
	            ../achievementEjb/src;
	            ../achievementEjb/ejbModule" 
	splitindex="true" use="false" version="true"
	encoding="UTF-8" docencoding="Shift_JIS" />
</target>
</project>

コマンドを実行

DOSプロンプトでコマンドを実行します。

> ant javadoc

以上、お疲れ様でした!

スポンサーリンク

この記事をシェア

アカウントをフォロー