JavaDoc生成文档

JavaDoc生成文档

通过命令行的方式

package com.chen.cm.base;

//加在类上面就是类的注释

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

    String name;

    //加在方法上面就是方法的注释

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

    //我是通过命令行  javadoc 参数 Java文件

    //作业：学会查找使用IDEA生成JavaDoc文档！  面向百度编程！
    //基础部分的一切知识，后面几乎每天都会用
}

1. 找到java所在位置
2. 在目录前输入cmd按回车，进入目录下的黑窗口
3. 输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java按回车生成一大串文件 注：-encoding UTF-8 -charset UTF-8 为了不乱码
4. 点开生成文件中的index.html文件查看首页
5. 通过命令行生成JavaDoc文档完成