JavaDoc命令行生成文档

命令行生成文档

1. 编写好类中的文档注释

文档注释：

/**
* 第一行需要有两个*
*/

有关文档注释的规范可以参考这里

package com.day01;

/**
 * @author Chen
 * @version 1.0
 * @since 1.8
 */
public class Demo08 {
    public static void main(String[] args) {
        String name;
    }

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

2.打开类所在的文件夹

在左边视图中用右键点击需要生成文档的类，打开该类所在的文件夹
右击–>打开于–>Explorer

3.打开命令行

在文件夹目录的最前方输入cmd并回车

4.生成文档

输入javadoc 类名.java

-encoding UTF-8 -charset UTF-8是设置编码格式
图中的警告是因为在进行文档注释的时候未在相应的标签后面输入信息

5.结束

当生成结束后，我们可以在类所在的文件夹内看到相应的文件

打开index.html,我们便可以看到这个类中方法的有关信息

补充：用IDEA生成Javadoc文档参考这里