文档章节

使用ant javadoc 命令个性化生成项目javadoc (主要参数说明)

小代码2016
 小代码2016
发布于 2016/04/04 21:08
字数 751
阅读 19
收藏 0

以前一直使用eclipse 自带的 export 的功能导出javadoc,功能本身还行,但是配置好了之后,要点击4次 next,不利于集成生成

 

maven 也可以生成javadoc,随着mvn install ,配置 

 

 

Xml代码   收藏代码
  1. <!-- -->  
  2. <plugin>  
  3.     <groupId>org.apache.maven.plugins</groupId>  
  4.     <artifactId>maven-javadoc-plugin</artifactId>  
  5.     <version>2.7</version>  
  6.     <executions>  
  7.         <execution>  
  8.             <id>attach-javadocs</id>  
  9.             <goals>  
  10.                 <goal>jar</goal>  
  11.             </goals>  
  12.         </execution>  
  13.     </executions>  
  14. </plugin>  
  15. <plugin>  
  16.     <inherited>true</inherited>  
  17.     <groupId>org.apache.maven.plugins</groupId>  
  18.     <artifactId>maven-source-plugin</artifactId>  
  19.     <executions>  
  20.         <execution>  
  21.             <id>attach-sources</id>  
  22.             <goals>  
  23.                 <goal>jar</goal>  
  24.             </goals>  
  25.         </execution>  
  26.     </executions>  
  27. </plugin>  
 

 

但是一来 本来不想生成javadoc的时候,mvn install 会比较慢

二来不能个性化配置

 

 

最终我单独 ant 里面配置 输出javadoc,在这个过程中,弄明白每个参数的含义还是有意义的 ,首先我们来看效果 

 

 


 

直接上我的build.xml

 

 

 

Xml代码   收藏代码
  1. <project name="feilong-core" basedir="." xmlns:artifact="antlib:org.apache.maven.artifact.ant">  
  2.     <description>feilong-core</description>  
  3.     <property file="${basedir}/build.properties" />  
  4.   
  5.     <property file="E:/DataCommon/java/Taglib/Apache Ant/config/build-feilong.properties" />  
  6.     <import file="${path.config}/build-config-common-nested.xml" />  
  7.     <import file="${path.config}/build-feilong-nested.xml" />  
  8.   
  9.     <!--由于使用的是maven 架构项目, 下面javadoc 需要引用 classpath -->  
  10.     <artifact:pom id="feilongMaven" file="pom.xml" />  
  11.     <artifact:dependencies filesetId="feilong.maven.dependencies.fileset" pathid="feilong.maven.dependencies.runtime" useScope="runtime">  
  12.         <pom refid="feilongMaven" />  
  13.     </artifact:dependencies>  
  14.   
  15.     <artifact:dependencies pathid="feilong.maven.dependencies.system" scopes="system">  
  16.         <pom refid="feilongMaven" />  
  17.     </artifact:dependencies>  
  18.   
  19.     <artifact:dependencies pathid="feilong.maven.dependencies.all">  
  20.         <pom refid="feilongMaven" />  
  21.     </artifact:dependencies>  
  22.   
  23.     <!--javadoc -->  
  24.     <target name="javadoc">  
  25.         <!-- Destination directory(输出文件的目的文件夹) -->  
  26.         <property name="destdir" value="E:\javadoc\feilong-core" />  
  27.   
  28.         <property name="source" value="1.6" />  
  29.   
  30.         <!-- 指定使用什么样式 -->  
  31.         <property name="stylesheetfile" value="${basedir}/${ant.project.name}-javadoc.css" />  
  32.         <!-- 配置预览页面 -->  
  33.         <property name="overview" value="src/main/java/overview.html" />  
  34.   
  35.         <!-- 这个参数可以用来配置帮助 -->  
  36.         <!--<property name="helpfile" value="src/main/java/overview.html" /> -->  
  37.   
  38.         <!-- 浏览器窗口标题文件(文本) -->  
  39.         <property name="windowtitle" value="feilong-core 1.0 API" />  
  40.         <property name="additionalparam" value="-encoding UTF-8 -charset UTF-8" />  
  41.   
  42.         <!-- Locale to be used -->  
  43.         <property name="locale" value="en_US" />  
  44.         <!-- Source file encoding name -->  
  45.         <property name="encoding" value="utf-8" />  
  46.         <property name="docencoding" value="utf-8" />  
  47.         <property name="charset" value="utf-8" />  
  48.   
  49.         <!-- 包含 @author paragraphs -->  
  50.         <property name="author" value="true" />  
  51.         <!-- 包含 @version paragraphs -->  
  52.         <property name="version" value="true" />  
  53.   
  54.         <property name="noindex" value="false" />  
  55.         <property name="nonavbar" value="false" />  
  56.         <property name="notree" value="false" />  
  57.         <property name="nodeprecatedlist" value="false" />  
  58.         <property name="nodeprecated" value="false" />  
  59.   
  60.         <!-- Access mode: one of public, protected, package, or private -->  
  61.         <property name="access" value="public" />  
  62.         <!-- Create class and package usage pages -->  
  63.         <property name="use" value="true" />  
  64.   
  65.         <property name="verbose" value="true" />  
  66.         <!-- 分割索引成单独的文件 如果是true,则生成index-files文件夹,里面存放单独的索引文件 -->  
  67.         <property name="splitindex" value="true" />  
  68.   
  69.         <!-- 保证生成的javadoc 是最新的 -->  
  70.         <mkdir dir="${destdir}" />  
  71.         <delete dir="${destdir}" verbose="true" />  
  72.   
  73.         <!-- javadoc -->  
  74.         <javadoc destdir="${destdir}" windowtitle="${windowtitle}" locale="${locale}" encoding="${encoding}" docencoding="${docencoding}" charset="${charset}"  
  75.             access="${access}" version="${version}" author="${author}" use="${use}" nodeprecated="${nodeprecated}" nodeprecatedlist="${nodeprecatedlist}" noindex="${noindex}"  
  76.             nonavbar="${nonavbar}" notree="${notree}" splitindex="${splitindex}" source="${source}" overview="${overview}" verbose="${verbose}" stylesheetfile="${stylesheetfile}"  
  77.             additionalparam="${additionalparam}" classpathref="feilong.maven.dependencies.all">  
  78.             <!-- Include title for the package index(first) page (html-code) -->  
  79.             <doctitle>feilong-core 1.0 API create by 飞天奔月</doctitle>  
  80.   
  81.             <!-- 下面三个参数,指定header footer bottom 不解释 -->  
  82.             <header>feilong-core 1.0 API</header>  
  83.             <footer>feilong-core 1.0 API</footer>  
  84.             <bottom>  
  85.                 <![CDATA[Copyright &copy; 2009-2012 by feilong]]>  
  86.             </bottom>  
  87.   
  88.             <fileset dir="src/main/java" defaultexcludes="yes">  
  89.                 <!--这里可以定制 你先哪些包生成 那些包不生成javadoc -->  
  90.                 <include name="com/feilong/commons/core/**" />  
  91.             </fileset>  
  92.         </javadoc>  
  93.   
  94.         <!-- javadoc 生成完成后,打开目标目录 -->  
  95.         <property name="_explorerPath" location="${destdir}" />  
  96.         <antcall target="Z_feilongExecExplorer" inheritall="true" />  
  97.     </target>  
  98. </project>  
 

 

 

下面要研究的是 怎么用ant 生成javadoc 之后 ,直接调用相关api 生成chm 格式的文档 

本文转载自:http://feitianbenyue.iteye.com/blog/1698109

共有 人打赏支持
小代码2016
粉丝 37
博文 328
码字总数 153495
作品 0
安阳
程序员
私信 提问
Intellij IDEA如何生成JavaDoc?

javadoc基本介绍 javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程...

武哥_话神
04/19
0
0
如何在Eclipse 中生成JavaDoc文档

如何在Eclipse 开发工具中生成JavaDoc文档,在这里简要的记录以下,方便日后查阅。 1 选中需要生成JavaDoc文档的项目,单击右键---》Export--》Export,选择Java下的JavaDoc。 具体如下图所示...

乌英达姆
2016/12/30
0
0
【Java学习笔记之十八】Javadoc注释的用法

Javadoc注释的用法

angel_kitty
2017/08/18
0
0
Java的注释说明

在Java里面主要有三种注释:行注释、段落注释、文档注释   1)行注释:行注释也成为单行注释,行注释使用 “//注释文字”的格式来对某一行的代码进行注释或者加以说明 public class LineCom...

origin
2014/06/24
257
0
如何规范生成JAVADOC帮助文档

如何规范生成JAVADOC帮助文档 1.文本注释(/** */)也叫归档注释。 归档注释是一种专用注释;当它放在类或类成员声明之前时,javadoc工具可以提取出这些注释并用它们来生成程序的HTML文档。归...

时刻在奔跑
05/24
0
0

没有更多内容

加载失败,请刷新页面

加载更多

java框架学习日志-2

上篇文章(java框架学习日志-1)虽然跟着写了例子,也理解为什么这么写,但是有个疑问,为什么叫控制反转?控制的是什么?反转又是什么? 控制其实就是控制对象的创建。 反转与正转对应,正转...

白话
9分钟前
0
0
Integer使用双等号比较会发生什么

话不多说,根据以下程序运行,打印的结果为什么不同? Integer a = 100;Integer b = 100;System.out.println(a == b);//print : trueInteger a = 200;Integer b = 200;System.out.pr...

兜兜毛毛
昨天
5
0
CockroachDB

百度云上的CockroachDB 云数据库 帮助文档 > 产品文档 > CockroachDB 云数据库 > 产品描述 开源NewSQL – CockroachDB在百度内部的应用与实践 嘉宾演讲视频及PPT回顾:http://suo.im/5bnORh ...

miaojiangmin
昨天
4
0
I2C EEPROM驱动实例分析

上篇分析了Linux Kernel中的I2C驱动框架,本篇举一个具体的I2C设备驱动(eeprom)来对I2C设备驱动有个实际的认识。 s3c24xx系列集成了一个基于I2C的eeprom设备at24cxx系列。at24cxx系列芯片包...

yepanl
昨天
5
0
设计模式之工厂模式

本篇博文主要翻译这篇文章: https://www.journaldev.com/1392/factory-design-pattern-in-java 由于翻译水平有限,自认为许多地方翻译不恰当,欢迎各位给出宝贵的建议,建议大家去阅读原文。...

firepation
昨天
11
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部