25JavaDoc生成文档

JavaDoc

• javado命令是用来生成自己API文档的：

  意思是生成自己类的文档注释，如下面例子

  百度搜索：JDK帮助文档https://tool.oschina.net/apidocs/apidoc?api=jdk-zh

package qianqian.base;
/**
 * @author qian
 * @version 1.8
 * @since 1.5
 *
 *
 */
 
 //注释加在类上面，是类注释
 //下面注释加在方法上面，是方法注释
 
public class doc {

    String name;//类
    //下面自动生成的内容是敲/**然后回车

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */


    public String test(String name) throws Exception{
        return name;
    }
}

• 参数信息：

  @author 作者名

  @version版本号

  @since指明需要最早 使用的jdk版本

  @param参数名

  @return返回值情况

  @throws异常抛出情况

通过CMD运行java文档

javadoc 参数 Java文件

右击文档—open in ----explor，进入文档，文档路径上输入cmd 回车

javadoc -encoding UTF-8 -charset UTF-8

用的javadoc命令，然后加了一堆参数，为了防止文档显得更优秀，不出现乱码

最后用doc.java把文件编译成一份文档

文档所文件夹会生成很多html文件，点开index.html

基础部分的一切只是，后面几乎每天都会用

作业：学会查找使用IDEA生产JavaDoc文档！

面向百度编程