`

ant+javadoc生成API文档

    博客分类:
  • J2EE
 
阅读更多
ant+javadoc生成API文档
分类: ant 2006-08-06 17:53 1579人阅读 评论(0) 收藏 举报
javadocantapiencodingexceptionimport
第一步,下载安装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就可以了
分享到:
评论

相关推荐

    如何用ant生成javadoc

    Javadoc是一种为Java语言编写的程序自动生成API文档的工具,它能够帮助开发者更好地理解和使用代码。而Apache Ant则是一种强大的构建工具,能够自动化各种任务,包括构建、测试和部署等。本文将详细介绍如何利用Ant...

    ant持续集成插件安装包(ant+jmeter)

    6. 文档:可能有相关的使用指南、教程或者API文档,解释如何集成Ant和JMeter以及如何执行持续集成。 在实际应用中,使用Ant和JMeter进行持续集成的过程可能包括以下步骤: 1. 配置Ant:设置Ant的环境变量,确保能够...

    ANT1.6+index文档全文件

    8. **外部工具集成**:Ant可以调用各种外部工具,如Java编译器(javac)、Javadoc生成器等。 通过阅读和理解这些文档,开发者可以有效地利用Ant 1.6来自动化他们的Java项目或其他类型项目的构建过程。尽管现代的...

    通过ant生成doc和zip

    - 通过`link`属性或`taglet`元素,你可以链接到其他API文档,或者自定义Javadoc的输出样式和内容。 2. **Zip任务**: - 在生成Javadoc之后,使用`zip`任务将文档打包成ZIP文件。 - `basedir`属性指定了要打包的...

    Ant 入门资料(完整版)

    可能的内容包括Ant的任务体系,如javac任务用于编译Java代码,javadoc任务生成API文档,copy和move任务用于文件操作,以及war和ear任务用于打包Web应用和企业级应用。此外,还可能涉及到条件语句、宏定义和自定义...

    apache ant1 9 4包 含文档

    这个jar包含了各种内置任务,如javac(用于编译Java源代码)、copy(用于复制文件和目录)、javadoc(用于生成API文档)等。此外,Ant还支持通过插件机制添加自定义任务,以满足项目的特殊需求。 Apache Ant 1.9.4 ...

    OFBiz-API-Docs

    有兴趣的朋友可以自己生成,ant命令是:docs-all,该命令生成帮助文档时会获取操作系统语言设置,要生成英文文档请先将操作系统语言改为英语,要生成中文文档需要在docs-all命令中的&lt;default-javadoc/&gt;添加属性...

    8_ant_通过ant生成doc和zip(基于实战的)

    生成DOC文档通常涉及到的是API文档或者项目报告的创建。在Java世界中,Javadoc是一个广泛使用的工具,它能从Java源代码中自动生成文档。Ant提供了`javadoc`任务来调用Javadoc。在`build.xml`文件中,你需要定义一个`...

    ant 中文帮助文档

    与Javadoc一起生成API文档;甚至可以与CVS、SVN等版本控制系统协同工作。 通过阅读这个“ant中文帮助文档”,开发者将能够理解Ant的基本原理,掌握如何编写和维护构建文件,以及如何利用Ant进行高效的项目构建和...

    Javadoc2chm工具

    2. **运行JavaDoc**:使用Javadoc命令生成HTML版的API文档,这通常通过配置构建脚本(如Ant或Maven)来自动化。 3. **运行Javadoc2CHM**:将生成的HTML目录作为输入,指定输出的CHM文件名,执行Javadoc2CHM工具。 4....

    jfreechart-1.0.19-javadoc.zip

    《JFreeChart 1.0.19 API文档详解》 JFreeChart是Java编程语言中的一款开源图表库,它提供了丰富的图表类型,包括折线图、柱状图、饼图、散点图等,广泛应用于数据分析和可视化展示。本文将深入解析JFreeChart ...

    javaDoc转换成chm文件

    JavaDoc是一种标准的Java文档工具,它能够自动生成关于Java源代码的API文档,通常以HTML格式呈现。这种文档格式方便开发者查阅类、接口、方法等的详细信息。然而,在某些情况下,用户可能希望将JavaDoc转换为CHM...

    POI包及API

    在标题提到的"POI包及API"中,包含了多个版本为3.11的POI库的jar文件以及一个名为"poiapi.zip"的API文档,这些资源对于Java开发者来说非常有用,尤其是需要处理Excel数据的时候。 1. **POI组件**: - **poi-ooxml-...

    apache-ant-1.9.6-bin.zip(有英文chm文档)

    - **外部工具集成**:Ant可以与各种工具集成,如Javadoc(生成API文档),ProGuard(代码混淆),甚至是其他构建工具如Maven或Gradle。 在实际开发中,Ant常用于自动化构建Java应用程序,从编译源代码、生成文档,...

    对于ANT的概述

    -- 生成API文档 --&gt; &lt;javadoc sourcepath="src" destdir="docs/api"/&gt; &lt;target name="jar" depends="javadoc"&gt; &lt;!-- 打包为JAR文件 --&gt; ,javadoc"&gt; &lt;!-- 执行所有任务 --&gt; ``` #### 总结 ANT作为...

    ant工具的使用

    3. `javadoc`: 生成项目API文档。 4. `build`: 编译源代码生成class文件。 5. `jar`: 打包编译后的类文件到JAR文件中。 6. `all`: 执行所有上述任务,包括编译、生成文档和打包。 Ant的优势在于其平台无关性和灵活...

    ant脚本资料ant

    - **生成文档**:使用`javadoc`任务生成API文档。 - **执行测试**:使用`junit`任务运行单元测试,确保代码质量。 - **部署应用**:根据需要,Ant可以将构建结果发布到服务器或归档存储。 5. **Ant的扩展性** -...

    ant打包部署工具,官方下载

    5. **生成文档**:通过与Javadoc集成,Ant可以自动生成项目的API文档。 6. **依赖管理**:Ant可以通过管理类库依赖关系,确保在构建过程中使用正确的版本。 7. **构建脚本**:Ant的XML配置文件(build.xml)允许...

Global site tag (gtag.js) - Google Analytics