Java/JSPDoc

JSPDocとは

JSPDoc ProjectはJSPのJavaDoc?を作成するためのツールです。いままで普通の？クラスなどはJavaDoc?を生成可能でしたが、JSPだけは作成できませんでした。それを解決することができます。

インストール

上記サイトより取得した、jspdocYYYYMMDD.jarと、gnu-regexp-1.1.4.jar(正規表現のためのjar？)にパスを通しておきます。gnu-regexpはhttp://www.cacas.org/java/gnu/regexp/ より取得できます。

実際はant経由でドキュメントを作成するようなので、build.xmlでパスを通せばよいでしょう。

使用方法

使用するbuild.xmlのサンプルです。

<!-- クラスパス名の定義 -->
<property name="jspdoc.jar" value="${jar.dir}/jspdoc20031118.jar" />
<property name="gnu.regexp.jar" value="${jar.dir}/gnu-regexp-1.1.4.jar" />

<path id="project.class.path">
	<pathelement path="${java.class.path}" />
	<pathelement path="${class.dir}" />
	<pathelement path="${jar.dir}" />
	<pathelement location="${jspdoc.jar}" />
	<pathelement location="${gnu.regexp.jar}" />
</path>
<!-- クラスパス名の定義 以上 -->

で、クラスパスを通しておきましょう。んで、以下のタスクを実行すればＯＫです。

<!-- ========== Generate JSPDocs for the program ========== -->
<target name="JSPdoc">
	<echo>Generating JSP Documentation</echo>
	<property name="jspdoc" value="jspdoc" />

	<delete dir="${jspdoc}" />
	<mkdir dir="${jspdoc}" />

	<java classname="ca.yourdecor.jspdoc.DirTree" fork="yes" maxmemory="256M">
		<classpath refid="project.class.path" />
		<arg value="war/WEB-INF/jsp" /> <- JSPファイルのディレクトリ
		<arg value="${jspdoc}" /> <- documentの出力先
		<arg value="null" /> <- Customizer？とりあえずnull
		<arg value="null" /> <- Exporter？とりあえずnull
	</java>
</target>

現在のアクセス:8214