JavaDoc生成文档

JavaDoc

用来生成自己API文档

Java帮助文档

点击跳转到Java帮助文档

package com.msj.base;

//类的注释
/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name; //属性

    //方法的注释
    /***
     * @param name
     * @return
     */
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{ //方法
        return name;
    }
    //老师通过命令行生成JavaDoc文档  javadoc 参数 Java文件
    //作业：学会查找使用IDEA生成JavaDoc文档！ 面向百度编程！
}

使用命令行生成JavaDoc文档

步骤一

步骤二 进入命令行窗口
地址前加cmd空格 点回车

输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java 命令 点回车

步骤三 打开index.html

点击跳转到狂神说b站视频