07 JavaDoc生成文档

JavaDoc

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

注释里面的文档注释

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

package com.study.base;

/**
 * @author 作者名
 * @version 版本号
 * @since 最早使用的jdk版本
 */

public class Doc {
    String name;

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

}

1. 加在类上面就是类上的注释，加在方法上就是对方法的注释

一、百度搜索jdk帮助文档

Java在线的帮助文档的网址

二、使用cmd生成javadoc

• 先找到类的所在路径，并用cmd打开

• 设置Java文档的参数，让它对中文的支持更优秀

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

-encoding 设置编码形式

-charset 设置字符集编码形式

• 执行命令行，显示如下

• 文件里会生成一堆文件，index.html是文档首页的意思

总结：JavaDoc生成文档的形式如下

javadoc 参数 Java文件

三、课后作业：使用IDEA生成Java文档文件

1.在IDEA中选择工具(Tool)选项卡打开

2.选择生成JavaDoc

• 第一步：选择生成JavaDoc文档的范围，我只对一个源文件生成Doc，所以选择文件。
• 第二步：输出目录最好新建一个文件夹，比较有条理和整洁
• 第三步：区域设置，决定文档的语言，简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
• 第四步：其他命令行参数：如果区域设置为中国，参数一般为-encoding UTF-8 -charset UTF-8
• 第五步：设置完成后点击确定即可生成Doc文档

3.查看JavaDoc文档

打开输出目录，就可以看到成功生成，打开index.html便可以查看生成的文档