文档章节

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

小代码2016
 小代码2016
发布于 2016/04/04 21:08
字数 751
阅读 15
收藏 0
点赞 1
评论 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 格式的文档 

© 著作权归作者所有

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

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

武哥_话神 ⋅ 04/19 ⋅ 0

如何在Eclipse 中生成JavaDoc文档

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

乌英达姆 ⋅ 2016/12/30 ⋅ 0

【Java学习笔记之十八】Javadoc注释的用法

Javadoc注释的用法

angel_kitty ⋅ 2017/08/18 ⋅ 0

Java的注释说明

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

origin ⋅ 2014/06/24 ⋅ 0

Java的注释说明

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

origin ⋅ 2014/06/24 ⋅ 1

javadoc做注释

javadoc做注释 一. Java 文档 // 注释一行 / ...... / 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ......... * ......... */ javadoc -...

科技小毛 ⋅ 2017/10/19 ⋅ 0

如何规范生成JAVADOC帮助文档

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

时刻在奔跑 ⋅ 05/24 ⋅ 0

JsDoc Toolkit 简介

JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 Java...

红薯 ⋅ 2009/10/16 ⋅ 1

javadoc的命令行语法

javadoc的命令行语法 javadoc的命令行语法如下: javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ] 参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明...

无聊的人们啊 ⋅ 2012/06/26 ⋅ 0

IOS Android项目注释规范

场景描述:最近整理公司开发的项目,发现公司项目很多地方写的不规范,尤其是注释;这对以后维护和开发带来了很多不便。尤其对于对项目本身不熟悉的人,在没有注释的情况下看项目会很费劲,通...

malawo ⋅ 2013/08/17 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

IDEA PermGen space内存溢出

解决方案: File -> Settings -> Build, Execution, Deployment / Build Tools / Maven / Runner下,找到VM Options选项,默认是空的,改为如下内容(或更大值)...

快乐的小火柴 ⋅ 7分钟前 ⋅ 0

前端常见跨域解决方案

什么是跨域? 跨域是指一个域下的文档或脚本试图去请求另一个域下的资源,这里跨域是广义的。 广义的跨域: 1.) 资源跳转: A链接、重定向、表单提交2.) 资源嵌入: <link>、<script>、<im...

临江仙卜算子 ⋅ 8分钟前 ⋅ 0

系统管理命令service

service命令用来控制系统服务的实用工具,例如启动、停止、重启和关闭系统服务,以及当前状态。当然也可以直接操作,例如/etc/init.d/mysqld restart等。 语法 service (选项)(参数) 选项...

Jpchina ⋅ 13分钟前 ⋅ 0

MySQL 联合索引的命中规则

为什么要用联合索引? 对于查询语句“SELECT T.* FROM T WHERE T.c1=1 AND T.c3=2”涉及到两列,这个时候我们一般采用一个联合索引(c1, c3);而不用两个单列索引,这是因为一条查询语句往往应...

hensemlee ⋅ 21分钟前 ⋅ 0

Spring 自动组件扫描

通常情况下都是在XML配置文件中手动声明Bean和组件的。不过Spring也可以自动扫描组件实例化Bean,这样就可以避免在XML文件中繁琐的Bean声明。 手动声明Bean: 这里不再啰嗦,就是简单地在XML...

霍淇滨 ⋅ 25分钟前 ⋅ 0

MapReduce简单需求分析-共同好友及查找互粉的情况

MapReduce的设计,最重要的是要找准key,然后制定一系列的数据处理流程。MapReduce的Map中,会把key相同的分配到同一个reduce中,对于key的选择,可以找到某个相同的因素。以下面的几个例子说...

Jason_typ ⋅ 27分钟前 ⋅ 0

springboot多数据源自动切换

SpringBoot多数据源切换,先上配置文件: 1.pom: <?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/20......

JackyRiver ⋅ 29分钟前 ⋅ 0

Boost库编译应用

版本:Boost 1.66.0 Windows库编译 官网指南:直接执行bootstrap.bat处理文件即可,可以我却遇到一堆的问题。 环境:Windows 10 + Visual Studio 2017 Boost编译出来库命名 boost库生成文件命...

水海云 ⋅ 34分钟前 ⋅ 0

解决Eclipse发布到Tomcat丢失依赖jar包的问题

如果jar文件是以外部依赖的形式导入的。Eclipse将web项目发布到Tomcat时,是不会自动发布这些依赖的。 可以通过Eclipse在项目上右击 - Propertics - Deployment Assembly,添加“Java Build ...

ArlenXu ⋅ 34分钟前 ⋅ 0

iview tree组件层级过多时可左右滚动

使用vue+iview的tree组件,iview官网iview的tree树形控件 问题描述:tree层级过多时左右不可滚动 问题解决:修改overflow属性值 .el-tree-node>.el-tree-node_children { overflow: vi...

YXMBetter ⋅ 36分钟前 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部