【Java学习笔记】【基础篇】07.JavaDoc

JavaDoc

1.介绍

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。

JavaDoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过JavaDoc就可以同时形成程序的开发文档了。

参数信息：

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

例如：

package com.AmazingMing.study;

/**
 * @author AmazingMing
 * @version 1.0
 * @since 1.8
 */

public class Doc {
    String name;

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

2.通过命令行生成JavaDoc文档

①右键类，找到Open In中Explorer在文件夹中打开。


②在导航栏前面输入cmd+空格，回车跳转到当前文件夹下的命令行


③在命令窗口下输入：

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

加入参数防止乱码问题：

-encoding UTF-8 -charset UTF-8
//使编码格式为UTF-8，字符格式为UTF-8，解决GBK乱码问题

④输入完命令后回车，出现以下指令：


⑤回到刚刚打开的文件夹，这时发现新生成了很多HTML文件，找到index.html，首页的文件，双击打开：


⑥进入以后点击Doc类


⑦此时可以查看代码生成的API文档


3.通过IDEA生成JavaDoc文档

①老方法右键类，找到Open In中Explorer在文件夹中打开。


②在文件夹中新建一个用来存放JavaDoc文档的文件夹（也可以建在别处）


③选择Tools中的Generate JavaDoc


④在Outout directory中写入将刚刚创建的文件夹地址


⑤在Locale中输入zh_CN表示中文，在Other command line arguments中输入-encoding UTF-8 -charset UTF-8防止乱码，点击OK即可。


⑥打开新建的JavaDoc文件夹，打开index.html文件就可以看到生成的API文档了。