Java（五）Javadoc生成文档

2023-01-01 12:18:35

Java添加文档注释

可以给类添加注释，也可以给函数添加注释；
添加注释的方法是，输入/**然后回车，会自动生成输入、输出和异常

/**
 * @author happy
 * @version 1.0
 * @since 1.8
 */
public class type {
    String name;
	/**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

生成文档

生成文档有两种方式，命令行生成或者使用编辑器（比如Idea）生成

命令行生成文档

终端中，进入到要生成文档的文件的位置，然后执行以下命令：

$ javadoc -encoding UTF-8 -charset UTF-8 type.java

进入对应的文件夹，即可看到生成的文件

使用Idea生成文档

可以选择生成整个项目的文档，也可以选择生成单文件的文档，文档生成后，会自动打开