`

Ant -- javadoc task

 
阅读更多
javadoc任务 用于生成api文档

属性:
sourcepath: 源文件的位置
sourcepathref: 赋值一个path引用
sourcefiles: 独立的源文件列表
至少要在以上3个或者内嵌<sourcepath>, <fileset> or <packageset> 中选一个。

destdir: 生成的api文档存放的地方
packagenames:包列表,支持通配符
packageList: 列表文件,包含要处理的包
以上的也可以使用内嵌<package> 来代替

excludepackagenames:要排除的包名
Windowtitle:打开api文档时的浏览器标题
access:四个级别private,protected(默认),public,package,
private-显示所有class和members;  public-只显示public的class和members;
protected显示protected和public 的class和members;package-显示package/protected/public classes and members


实例:
以下3种 是对等的
1. <javadoc packagenames="com.dummy.test.*"
           sourcepath="src"
           excludepackagenames="com.dummy.test.doc-files.*"
           defaultexcludes="yes"
           destdir="docs/api"
           author="true"
           version="true"
           use="true"
           windowtitle="Test API">
    <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
    <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
    <tag name="todo" scope="all" description="To do:"/>
    <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
    <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
    <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:\tmp"/>
    <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
  </javadoc>

2. <javadoc
           destdir="docs/api"
           author="true"
           version="true"
           use="true"
           windowtitle="Test API">

    <packageset dir="src" defaultexcludes="yes">
      <include name="com/dummy/test/**"/>
      <exclude name="com/dummy/test/doc-files/**"/>
    </packageset>

    <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
    <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
    <tag name="todo" scope="all" description="To do:"/>
    <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
    <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
    <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:\tmp"/>
    <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
  </javadoc>

3. <javadoc
           destdir="docs/api"
           author="true"
           version="true"
           use="true"
           windowtitle="Test API">

    <fileset dir="src" defaultexcludes="yes">
      <include name="com/dummy/test/**"/>
      <exclude name="com/dummy/test/doc-files/**"/>
    </fileset>

    <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
    <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
    <tag name="todo" scope="all" description="To do:"/>
    <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
    <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
    <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:\tmp"/>
    <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
  </javadoc>
分享到:
评论

相关推荐

    apache-ant-1.9.9.zip

    Apache Ant的核心概念是任务(Task),这些任务是构建过程中执行的操作,如编译源代码、打包、部署等。Ant通过XML文件(通常命名为build.xml)来定义构建过程,其中包含了各种任务的配置。在描述中提到的"使用非常...

    apache-ant-1.9.3-src.tar

    Ant通过调用target树,就可以执行各种task。每个task实现了特定接口对象。由于Ant构建文件时XML格式的文件,所以和容易维护和书写,而且结构很清晰。 Ant可以集成到开发环境中。由于Ant的跨平台性和操作简单的特点...

    rh-maven33-objectweb-anttask-javadoc-1.3.2-10.15.el7.noarch.rpm

    官方离线安装包,测试可用。使用rpm -ivh [rpm完整包名] 进行安装

    apache-ant-1.8.2

    9. **外部工具集成**:Ant可以调用各种外部工具,如Java编译器、Javadoc生成器等,通过指定命令行参数实现与这些工具的交互。 10. **部署和发布**:Ant可以用来部署应用到远程服务器,或者打包应用为可分发的格式,...

    ant-1.7.1.jar.zip_ANT-1.7.1

    6. 改进的编译支持:Ant 1.7.1对Java编译任务(javac)进行了优化,支持更多的编译选项,并且能更好地与其他Java工具如Javadoc协同工作。 7. 多平台兼容性:作为Java工具,Ant天生具有跨平台性,可以在任何安装了...

    sonar-java-plugin-6.2.0.21135-javadoc.jar

    最新的java SonarQube 代码格式检测工具。

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

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

    apache-ant-1.9.14.zip

    1. **任务(Task)**:Ant的工作单元,执行特定的动作,如编译Java源代码、创建JAR文件、复制文件等。例如,`javac`任务用于编译Java源代码,`copy`任务用于复制文件。 2. **属性(Properties)**:用于存储可配置的值...

    Ant-JAVA深层探究

    3. **任务和目标**:Ant引入了任务(task)的概念,每个任务执行特定的操作,如编译源代码、运行测试、打包等。通过将多个任务组合成目标(target),可以创建复杂的构建流程。 4. **灵活性与扩展性**:除了内置的...

    apache-ant-1.7.1-manual

    10. **外部工具集成**:Ant可以与各种外部工具如JUnit(单元测试)、Javadoc(API文档生成)等紧密集成,实现完整的开发流程自动化。 11. **发布(Deployment)**:Ant不仅限于本地构建,还可以配置远程服务器部署...

    ant-1.7下载附学习资料

    在Ant 1.7中,开发者可以定义目标(target)和任务(task),每个目标可以包含多个任务,任务是构建过程中的基本操作单元。 2. **任务集**:Ant 1.7提供了大量的内置任务,如`javac`用于编译Java源代码,`jar`用于...

    如何用ant生成javadoc

    Ant提供了丰富的内置任务(task),支持多种任务的组合和定制,非常适合大型项目的自动化构建需求。 **2. 安装Ant** 按照以下步骤安装Ant: - **下载Ant**:访问Ant官网([http://ant.apache.org/]...

    编译打包工具-Ant

    虽然 Ant 可调用的外部应用种类非常丰富,但其实最常用的就 2,3 个:比如 javac、javadoc、jar 等。 Ant 与 makefile 的比较,Makefile 有一些不足之处,比如很多人都会碰到的烦人的 Tab 问题。Ant 则与一般基于...

    Ant教程-详细使用方法

    ### Ant教程—详细使用方法 #### 一、Ant简介及背景 Apache Ant 是一款基于 Java 的构建工具,其设计初衷是为了克服传统构建工具(如 Make)存在的诸多限制,特别是跨平台开发的问题。Ant 旨在提供一种更为灵活且...

    通过ant生成doc和zip

    Ant的任务(task)是执行特定操作的基本单元,如编译源代码、运行测试、打包应用等。在本例中,我们需要关注两个关键任务:`javadoc`和`zip`。 1. **Javadoc任务**: - 首先,你需要在Ant构建文件(build.xml)中...

    ant脚本资料ant

    - **任务(Task)**:是Ant的基本工作单元,比如编译源代码、复制文件、运行测试等,每个任务都有其特定的用途和属性。 2. **Ant脚本编写** - **XML结构**:Ant脚本以XML格式编写,遵循特定的命名空间和元素结构...

    ant 1.6工具下载

    Ant的核心概念是任务(Task),这些任务是可执行的操作单元,比如编译源代码、打包JAR文件、运行测试等。在Ant 1.6版本中,已经包含了丰富的内置任务,覆盖了开发流程中的大部分需求。用户可以通过编写build.xml文件...

    java的Ant打包工具

    Ant的核心概念是基于任务(task)的,每个任务都是一个特定的Java类实现,可以执行诸如编译、拷贝、压缩、解压、单元测试等操作。在XML配置文件中,这些任务被组织成一系列目标(target),形成一个有序的构建流程。例如...

Global site tag (gtag.js) - Google Analytics