需求

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

Project

                        |-- pom.xml

                        |-- Module1

                                |   `-- pom.xml

                        |-- Module2

                                |   `-- pom.xml

                        |-- Module3

                                |-- pom.xml

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

基本使用

插件的基本配置非常easy：

<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插件生成文档的更多相关文章

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

    版权声明:本文为博主原创文章,未经博主允许不得转载.   目录(?)[+]   需求 最近要对一个项目结构如下的Maven项目生成JavaDoc文档. Project                  ...

  2. <转>创建支持eclipse的多模块maven项目

    如何使用eclipse创建Maven工程及其子模块 1,首先创建一个父类工程   子模块继承父类工程      并在父类工程的pom.xml文件中定义引入的jar及其版本号     子模块可以引用 2 ...

  3. 使用eclipse生成文档（javadoc）

    使用eclipse生成文档(javadoc)主要有三种方法:1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步.在Java ...

  4. 使用Sphinx为你的python模块自动生成文档

    Sphinx是一个可以用于Python的自动文档生成工具,可以自动的把docstring转换为文档,并支持多种输出格式包括html,latex,pdf等. 安装 创建一个sphinx项目 下面的命令会 ...

  5. 使用eclipse生成文档（javadoc）主要有三种方法：

    使用eclipse生成文档(javadoc)主要有三种方法: 1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在Ja ...

  6. 使用swagger在netcorewebapi项目中自动生成文档

    一.背景 随着前后端分离模式大行其道,我们需要将后端接口撰写成文档提供给前端,前端可以查看我们的接口,并测试,提高我们的开发效率,减少无效的沟通.在此情况下,通过代码自动生成文档,这种需求应运而生,s ...

  7. idea运行javadoc生成文档以及 报错编码gbk的不可映射字符坑

    将项目类信息生成文档 idea整合了javadoc的操作,可以一键生成doc文档 方法: 选中你要生成文档的项目 点击上方tools->Generate JavaDoc 运行即可 注意这里有一个 ...

  8. 第4天 JavaDoc生成文档&Java流程控制（第一节：用户交互Scanner）

    JavaDoc生成文档 javadoc命令是用来生成自己的API文档 参数信息: @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @ ...

  9. 为Unity项目生成文档(二)

    Unity项目生成文档 接着上篇文章:为Unity项目生成文档(一) .Net项目可在VS配置XML 我们可以在VS中通过配置来生成xml文件,但是unity的project,就算同样配置了xml文档 ...

随机推荐

  1. 【C++学习笔记】继承与派生基础概念

    面向对象的程序设计主要有四个特点:抽象.封装.继承和多态.其中继承是我认为最最重要的一个特性,可以说继承是面向对象的精华所在. 举一个继承的浅显易懂的例子:假如我们已经有了一个“马”的类,其中成员变量 ...

  2. Tree（未解决。。。）

    Tree Time Limit: 10000/5000 MS (Java/Others)    Memory Limit: 65536/65536 K (Java/Others)Total Submi ...

  3. Vmware中Ubuntu挂ISO到虚拟光驱

    Ubuntu 下挂ISO到虚拟光驱的方法 https://i.cnblogs.com/EditPosts.aspx?opt=1 如果要ubuntu找到rpm软件包,需要把iso挂载到/media/cd ...

  4. Two Sum-n方优化与C++map的使用

    LeetCode第一题,刚拿到题目时虽然明知道n方的遍历算法会超时,但还是不信邪的提交了一次,然而编程不存在运气,TLE不可避免.但是之后的思维方式比较直接,我并没有立刻想到O(n)的方法,想了一种先 ...

  5. BZOJ 1600: [Usaco2008 Oct]建造栅栏( dp )

    QAQ我没读过书...四边形都不会判定了 简单的dp.... --------------------------------------------------------------------- ...

  6. jQuery $.fn.extend方式自定义插件

    之前例子是扩展jQuery的工具方法,即通过$.xxx(para);的形式来使用的.下面是扩展jquery对象的方法,即任意一个jquery对象都已访问. 具体如下: wyl.js: (functio ...

  7. .NET参数化Oracle查询参数

    最近在做数据库移植工作(SqlServer 2008 -> Oracle 11g),遇到一些不兼容的问题,以下是一个参数化方面的区别,资料来自其他网友,在此整理了一下. public stati ...

  8. YIi配置debug工具、yii配置gii工具

    $config['bootstrap'][] = 'debug';$config['modules']['debug'] = [ 'class'=>'yii\debug\Module', 'al ...

  9. poj 1604 Just the Facts

    /** 大意: 求n! 结果 从左到右 第一个非零数 跟 1150 差不多.. **/ #include <iostream> #include <cstdio> using ...

  10. U-Boot在FL2440上移植（四）----支持网卡DM9000和烧写yaffs文件系统

    <一>支持网卡芯片DM9000 在driver下,有网卡驱动DM9000x.c 和 DM9000x.h DM9000接在BANK4,位宽16 在include/configs/TX2440 ...