Maven生成JavaDoc

来源：互联网发布：短篇小说推荐知乎编辑：程序博客网时间：2024/06/05 03:23

1、Maven

1.1 添加变量，pom.xml

java.home是JDK的根目录，这里以Mac为例

<properties>        <jdk.version>1.7</jdk.version>            <java.home>/Library/Java/JavaVirtualMachines/jdk1.7.0_80.jdk/Contents/Home/</java.home></properties>

1.2 添加插件，pom.xml

<build>    <plugins>        <plugin>            <groupId>org.apache.maven.plugins</groupId>            <artifactId>maven-compiler-plugin</artifactId>            <configuration>                <source>${jdk.version}</source>                <target>${jdk.version}</target>            </configuration>        </plugin>        <plugin>            <groupId>org.apache.maven.plugins</groupId>            <artifactId>maven-javadoc-plugin</artifactId>            <version>2.9.1</version>            <configuration>                <aggregate>true</aggregate>                <reportOutputDirectory>../javadocs</reportOutputDirectory>                <destDir>security-javadoc</destDir>                <javadocExecutable>${java.home}bin/javadoc</javadocExecutable>                <tags>                    <tag>                        <name>Description</name>                        <placement>a</placement>                        <head>功能描述:</head>                    </tag>                </tags>            </configuration>        </plugin>    </plugins></build>

1.3 标签解释

reportOutputDirectory: javadoc的输出目录destDir: 生成的javadoc文件名称tags: 自定义标签组tag: 自定义标签name: 自定义标签的名称placement: maven提供的8种标签范围head: 描述

1.4 接口展示

public interface UserService {    /**     * @Description 通过Id查询用户     * @author wangjp     * @param id:用户Id     * @param name:用户名     * @return com.iframe.entity.UserInfo 实体对象     * @Date: 2017-10-19 21:50     */    UserInfo findUserById(String id, String name);}

1.5 界面展示

这里写图片描述

2、Intellij IDEA

2.1 操作步骤

Tools -> Generate JavaDoc

2.2 解决乱码

在 Other command line arguments 中输入:-encoding utf-8 -charset utf-8

2.3 图形展示

这里写图片描述

3、Eclipse

// TODO

Hero鹏，一个伟大的名字

如有疑问或是吐槽者，都可以联系我，

HomePage: www.crazyboy2016.com
Email: wangjianpeng228@163.com
GitHub: wangjianpeng2016
Blog: Hero鹏

阅读全文

0 0