javadoc生成文档

javadoc生成文档

以前看博客最讨厌别人不加图片，难以理解，现在天天在公司一张图片都无法上传，自己都崩溃了

支持的常用标注

@author 作者

@version 版本

@since jdk版本

@param 参数说明

@return 返回值说明

@throws 抛出异常

示例代码

package com.example.demo_kuang.base;

/**
 * @author ohmydream
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * test
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception {
        return name;
    }
}

生成文档方法

第一种：命令行 在代码目录下输入：java -encoding UTF-8 -charset UTF-8 Doc.java

第二种：idea->Tools->Generate javaDoc…

​ 选择file

​ 选择output directory

​ other command line arguments 填入-encoding UTF-8 -charset UTF-8

​ 点击ok

在当前目录或者设置的输出目录下找到index.html 双击打开查看生成文档