1. 程式人生 > >Ant生成Java幫助文件doc

Ant生成Java幫助文件doc

程式碼總覽

Student.java

package com.itlwc;

/**
 * 使用者管理物件
 * 
 * @author Lwc
 */
public class Student {
	/**
	 * 使用者唯一標識,不能重複
	 */
	private int id;
	/**
	 * 使用者名稱稱
	 */
	private String username;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}
}

build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project default="doc">
	<property name="src.dir" location="src" />
	<property name="build.dir" location="build" />
	<property name="build.doc" location="${build.dir}/doc/api" />
	<property name="packagenames" value="com.itlwc.*" />

	<!--專案清理工作-->
	<target name="clean">
		<!--刪除build資料夾-->
		<delete dir="${build.dir}" />
	</target>

	<!--建立資料夾-->
	<target name="createFolders" depends="clean">
		<!--建立build資料夾-->
		<mkdir dir="${build.dir}" />
		<!--建立存放幫助文件資料夾-->
		<mkdir dir="${build.doc}" />
	</target>

	<!--生成幫助文件-->
	<target name="doc" depends="createFolders">
		<!--
			sourcepath		src原始檔目錄
			packagenames	生成com.itlwc包中的所有檔案
			destdir			目標檔案目錄
			charset			字元編碼
			docencoding		文件的字元編碼
			encoding		生成的字元編碼
			classpath		基於誰來寫的doc
			private			被修飾為private也生成
			windowtitle		doc標題
			use				是否把每個包中的生成
		-->
		<javadoc 
			sourcepath="${src.dir}" 
			packagenames="${packagenames}" 
			destdir="${build.doc}"
			charset="GBK"
			docencoding="GBK"
			encoding="GBK"
			private="true"
			windowtitle="MyStudentDoc"
			use="true">
		</javadoc>
	</target>
</project>

doc效果圖