ant+javadoc生成API文档

第一步,下载安装jdk和ant包
下载地址分别为:
http://java.sun.com/javaee/downloads/index.jsp
http://ant.apache.org/

第二步,设置环境变量
我用的操作系统为windowsXP,
打开“我的电脑”-->属性-->高级-->环境变量

增加一个系统变量:
JAVA_HOME
C:/j2sdk1.4.2_04

path增加:
%JAVA_HOME%/bin;D:/tools/apache-ant-1.6.5/bin

其中C:/j2sdk1.4.2_04为jdk的安装路径
D:/tools/apache-ant-1.6.5包的解压路径

第三步,建立文件目录结构:

+--antexample
   |
   +--src
   |  |
   |  +--laochake
   |     |
   |     |--HelloWord.java
   |
   |--build.xml


第四步,编写HelloWord.java代码文件
(为了防止乱码,我用UTF-8编码保存文件)

package laochake;
import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * 第一个 ant 和 javadoc 测试程序
 * @author laochake
 * @version 1.0
 */
public class HelloWord {
   
    /**
     * <b>程序的入口,显示今天的日期</b>
     * @param args 参数列表
     * @return 无返回值
     * @exception 任何未被捕捉的的异常
     */
    public static void main(String[] args) {
        System.out.println("今天是:");
        System.out.println(new SimpleDateFormat("yyyy-M-d").format(new Date()));
    }
}


第五步,编写build.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<project name="firstAnt" default="createdoc">
    <property name="src.dir" value="src"/>
    <property name="doc.dir" value="doc"/>
    <target name="createdoc">
     <delete dir="${doc.dir}" />
     <mkdir dir="${doc.dir}"/>
     <javadoc destdir="${doc.dir}" encoding="UTF-8" docencoding="UTF-8">
      <packageset dir="${src.dir}">
       <include name="**"/>
      </packageset>
     </javadoc>
    </target>
</project>

第六步,运行ant脚本
运行cmd,转到antexample目录下:
输入ant,然后回车执行

最后,大功告成
antexample下多了一个doc目录,
双击打开 index.html,如果你看到的是乱码
就把浏览器的编码设为utf-8就可以了

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值