多模块Maven项目如何使用javadoc插件生成文档

需求

最近要对一个项目结构如下的Maven项目生成JavaDoc文档。

这个就需要用到本文将要提出的一个Maven插件：javadoc。

基本使用

插件的基本配置很简单：

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
</plugin>

如果对于一个普通的Maven项目，那么这个配置就可以让你输出一个JavaDoc文档了（使用javadoc:javadoc命令）。

多模块Maven项目

而我们现在是一个多模块的Maven项目，那么就需要一些额外的配置来完成此操作：

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<aggregate>true</aggregate>
</configuration>
</plugin>

就是一个aggregate设置为true，就可以让你在父项目运行javadoc:javadoc的时候，就会将子模块的JavaDoc生成在父项目的target下，并且会将其整合成一个JavaDoc。

自定义标签

现在问题来了：

我们的类中的方法注释如下

/**
* @author : 张三
* @group : group
* @Date : 2014-01-26 21:14:49
* @Comments : 页面所含操作增删改查的ejb接口
* @Version : 1.0.0
*/
public interface IOperationBean {
/**
* @MethodName : getOperationByID
* @Description : 根据Id获得页面所含操作
* @param ID 页面所含操作ID
*/
PageOperation getOperationByID(String ID);
}

而我们在生成JavaDoc后，并没有看到Description和MethodName这两个注解中对应的内容。也就导致了方法的说明不翼而飞了。

经过实验，要想像jdk那样让方法的描述紧跟在方法名后面，是需要这样添加注释的：

/**
* 根据Id获得页面所含操作
* @param ID 页面所含操作ID
*/
PageOperation getOperationByID(String ID);

已经到了项目后期，现在再让大家去改这些有些说不过去，查了下官网，发现有自定义标签，正好解决的就是这样的问题。

而这次问题的出现，还是源于我们对于JavaDoc生成不熟悉。

废话不多说，直接看例子：

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<aggregate>true</aggregate>
<tags>
<tag>
<name>Description</name>
<placement>a</placement>
<head>用途</head>
</tag>
</tags>
</configuration>
</plugin>

说明：

1.name为你Java代码中的注解的名字

2. placement这个在官网上有8种，我也自己试了下，其实这个就是说你要把哪些（方法、字段、类）上面的注解放到JavaDoc中

3.head，如果不写这个，用的就是name，如果写了，那么显示效果如下：

这样，你就既可以定义自己的注释规范，又可以生成相应的JavaDoc文档了

自定义路径

这个功能一般不会用到，只是顺便看了一下，就写下来吧。

在这里需要叨念两句关于约定优于配置，在最初我用Maven的时候，就看到过这样的话，Maven目录可以不这样设置么？可以，你可以自己改。

只能说我们在大部分时候，是不需要改这个，但不意味着我们在做的时候就可以把这个做死，这样于用户，于今后的维护来说，都不是一个好的选择。

两句叨念完了，现在来看怎么设置吧：

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<reportOutputDirectory>../myoutput</reportOutputDirectory>
<destDir>myapidocs</destDir>
</configuration>
</plugin>

说明：

1.reportOutputDirectory是说的路径

2.destDir是说的目标文件夹

到这里Maven多模块下使用javadoc插件生成JavaDoc文档过程中遇到的问题就都解决了。

多模块Maven项目如何使用javadoc插件生成文档的更多相关文章

多模块Maven项目怎样使用javadoc插件生成文档
需求近期要对一个项目结构例如以下的Maven项目生成JavaDoc文档. Project |-- pom.xml ...
<转>创建支持eclipse的多模块maven项目
如何使用eclipse创建Maven工程及其子模块 1,首先创建一个父类工程子模块继承父类工程并在父类工程的pom.xml文件中定义引入的jar及其版本号子模块可以引用 2 ...
使用eclipse生成文档（javadoc）
使用eclipse生成文档(javadoc)主要有三种方法:1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步.在Java ...
使用Sphinx为你的python模块自动生成文档
Sphinx是一个可以用于Python的自动文档生成工具,可以自动的把docstring转换为文档,并支持多种输出格式包括html,latex,pdf等. 安装创建一个sphinx项目下面的命令会 ...
使用eclipse生成文档（javadoc）主要有三种方法：
使用eclipse生成文档(javadoc)主要有三种方法: 1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在Ja ...
使用swagger在netcorewebapi项目中自动生成文档
一.背景随着前后端分离模式大行其道,我们需要将后端接口撰写成文档提供给前端,前端可以查看我们的接口,并测试,提高我们的开发效率,减少无效的沟通.在此情况下,通过代码自动生成文档,这种需求应运而生,s ...
idea运行javadoc生成文档以及报错编码gbk的不可映射字符坑
将项目类信息生成文档 idea整合了javadoc的操作,可以一键生成doc文档方法: 选中你要生成文档的项目点击上方tools->Generate JavaDoc 运行即可注意这里有一个 ...
第4天 JavaDoc生成文档&Java流程控制（第一节：用户交互Scanner）
JavaDoc生成文档 javadoc命令是用来生成自己的API文档参数信息: @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @ ...
为Unity项目生成文档(二)
Unity项目生成文档接着上篇文章:为Unity项目生成文档(一) .Net项目可在VS配置XML 我们可以在VS中通过配置来生成xml文件,但是unity的project,就算同样配置了xml文档 ...

随机推荐

DOM对象之document对象
DOM对象:当网页被加载时,浏览器会创建页面的文档对象模型(Document Object Model). HTML DOM 模型被构造为对象的树. 打开网页后,首先看到的是浏览器窗口,即顶层的win ...
Complete uninstall on Mac, HELP!
Remove these directories: /Applications/Xamarin Studio.app /Developer/MonoTouch /Developer/MonoAndro ...
面试笔试-脚本-1：使用shell脚本输出登录次数最多的用户
原题目: 一个文本类型的文件,里面每行存放一个登陆者的IP(某些行是反复的),写一个shell脚本输出登陆次数最多的用户. 之前刚看到这个题目时,立即没有想到一行直接解决的办法,尽管知道能够先进行排序 ...
Objective-C中的一些特殊的数据类及NSLog的输出格式
NSLog的格式如下所示: %@ 对象 %d, %i 整数 %u 无符整形 %f 浮点/双字 %x, %X 二进制整数 %o 八进制整数 %zu size_t % ...
HDU 4888 Redraw Beautiful Drawings 网络流建图
题意: 给定n, m, k 以下n个整数 a[n] 以下m个整数 b[n] 用数字[0,k]构造一个n*m的矩阵若有唯一解则输出这个矩阵.若有多解输出Not Unique,若无解输出Impossib ...
ibatis.net：第五天，QueryForObject
xml <statement id="LoadOrder" parameterClass="int" resultClass="Order&qu ...
python测试开发django-42.auth模块登陆认证
前言在开发一个网站时,经常会用到用户的注册和登陆相关的账号管理功能,auth模块是Django提供的标准权限管理系统,可以提供用户身份认证, 用户组和权限管理. 像用户注册.用户登录.用户认证.注销 ...
SharePoint 2013 安装.NET Framework 3.5 报错
环境描述操作系统:Windows Server 2012 R2 Datacenter版本安装报错中途接手安装SharePoint Server 2013 with sp1,配置向导报错如下: A ...
清道夫第一季/全集Ray Donovan迅雷下载
清道夫第一季 Ray Donovan Season 1 (2013)本季看点:Ray Donovan.一位专职于为洛杉矶的名人和富豪服务的神秘人士.他可以巧妙的解决这个城市中富豪们的那些最麻烦同时又 ...
TextView字体，行距，html格式，超链接，最大长度的设定
颜色,大小  <TextView android:id="@+id/textView1" an ...