javaDoc生成文档

package Test2;

/**
 * @author  zhuo
 *
 */
public class Test2_main {
    /**
     *
     * @param args
     */
    public static void main(String[] args) {
        User u = new User();
        System.out.println(u.no);
        System.out.println(u.userName);
        System.out.println(u.addr);
    }
}

其中的
/**

• @author zhuo

*/
是java的文档注释

@author 作者
@version 版本号
@since 指明需要最早使用jdk的版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

可以在dos窗口中使用javadoc（若文档中有中文则可使用javadoc -encoding UTF-8 -charset UTF-8）

找到文件所在路径，使用cmd命令进入
【 在idea中可加载到文件路径，使用cmd cd 路径 打开doc窗口】
运行结果如下

路径>javadoc Test2_main.java
正在加载源文件Test2_main.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_271
正在构建所有程序包和类的树...
正在生成.\Test2\Test2_main.html...
Test2_main.java:10: 警告: @param 没有说明
    * @param args
      ^
正在生成.\Test2\package-frame.html...
正在生成.\Test2\package-summary.html...
正在生成.\Test2\package-tree.html...
正在生成.\constant-values.html...
正在构建所有程序包和类的索引...
正在生成.\overview-tree.html...
正在生成.\index-all.html...
正在生成.\deprecated-list.html...
正在构建所有类的索引...
正在生成.\allclasses-frame.html...
正在生成.\allclasses-noframe.html...
正在生成.\index.html...
正在生成.\help-doc.html...
1 个警告

运行成功后会在该路径下生成很多html文件，该html文件即是所生成的API文档

在idea中有生成javadoc文档的功能
在工具–>生成javadoc文档—>1、输出路径/output direcotory
2、Locale输入zh_CN
3、-encoding utf-8 -charset utf-8
4、点击ok

然后点击确定以后我们就等待IntelliJ IDEA给我们生成JavaDoc文档即可，等到输出栏出现如下图所示的提示代表生成完毕