JAVA基础-javaDoc--Day005

JavaDoc

javadoc命令是用来生成自己API文档的

JDK帮助文档网站

参数信息

• @author 作者名
• @version 版本号
• @since 之名需要最早使用的jdk版本
• @param 参数名
• @return 返回值情况
• @throws 异常抛出情况

package haha.base;
//文档注释
/**
 * @outhor haha     //作者
 * @version 1.0     //版本
 * @since 1.9       //自然号，版本
 * */


public class Doc {

    String name; //属性

    /**
     * @author haha
     * @param name
     * @return
     * @throws Exception          //报错
     */
    public String test(String name) throws Exception{      //方法
        return name;
    }


}

命令行生成生成index.html

打开cmd

在命令里输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java

之后再文件夹里找到index.html双击打开。（主页面）

JAVA ider生成javaDoc文件方法

1. 新建一个project文件

2. 

3. 

4. 点击OK，在文件里找到index.html即可

java基础学完
感想，好在有编程基础，java基础学起来比较轻松。继续加油！