Maven生成JavaDoc

1、Maven

1.1 添加变量,pom.xml

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

<properties>
        <jdk.version>1.7jdk.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.pluginsgroupId>
            <artifactId>maven-compiler-pluginartifactId>
            <configuration>
                <source>${jdk.version}source>
                <target>${jdk.version}target>
            configuration>
        plugin>

        <plugin>
            <groupId>org.apache.maven.pluginsgroupId>
            <artifactId>maven-javadoc-pluginartifactId>
            <version>2.9.1version>
            <configuration>
                <aggregate>trueaggregate>
                <reportOutputDirectory>../javadocsreportOutputDirectory>
                <destDir>security-javadocdestDir>
                <javadocExecutable>${java.home}bin/javadocjavadocExecutable>
                <tags>
                    <tag>
                        <name>Descriptionname>
                        <placement>aplacement>
                        <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 界面展示

Maven生成JavaDoc_第1张图片

2、Intellij IDEA

2.1 操作步骤

Tools -> Generate JavaDoc

2.2 解决乱码

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

2.3 图形展示

Maven生成JavaDoc_第2张图片

3、Eclipse

// TODO

Hero鹏,一个伟大的名字

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

HomePage: www.crazyboy2016.com
Email: [email protected]
GitHub: wangjianpeng2016
Blog: Hero鹏

你可能感兴趣的:(Maven生成JavaDoc)