java基础知识—javaDoc生成HTML文档

Javadoc 生成文档

用命令行命令生成自己的API文档

1.先建立Doc.java文件

/**
 * @author xuehouniao
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author xuehouniao
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name)throws Exception{
        return  name;
    }
    //这是通过命令行  javadoc  参数 Java 文件
    //             javadoc -encoding UTF-8 charset UTF-8 Doc.java

2.点击文件所在的位置

3.在通过路径，打开cmd命令行，输入命令：javadoc -encoding UTF-8 charset UTF-8 Doc.java

4.然后，就会生成我们所需的API文件

5.双击index.html 文件，就得到我们所需的文件

使用IDEA生成Javadoc 文件

1.打开tools

2.设置四个东西

• 生成指定的文件

• 指定的路径

• Locale: zh_CN

• Other command line arguments: -encoding UTF-8 -charset UTF-8 -windowtitle “接口文档3.4” -link http://docs.Oracle.com/javase/7/docs/api

3.即可生成Javadoc文档

原文地址：https://blog.csdn.net/Xun_independent/article/details/112391783?utm_term=javadoc%E7%94%9F%E6%88%90%E6%96%B9%E5%BC%8F&utm_medium=distribute.pc_aggpage_search_result.none-task-blog-2~all~sobaiduweb~default-0-112391783&spm=3001.4430