JavaDoc

之前在注释的学习中除了单行注释和多行注释 还有文档注释 在文档注释中可以添加参数 作者名 版本号等等 添加在类上面就是类的注释 添加在方法上面就是方法的注释

package com.huang.base;

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

    String name;

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

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

右击类 选择在文件夹中打开

接着在导航栏地址前覆盖地址 在前面加上cmd加空格 然后回车 打开命令行 用命令行来生成javadoc文档

格式: javadoc 参数 java文件

这里encoding是编码的意思 charset是字符集编码 这两个参数的意义是这个地址可能含有中文 为了不出现乱码 添加这两个参数 使编码和字符集编码都为UTF-8

D:\ideaworkspace\projects\javaSE\javajichuyufa\src\com\huang\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java

回车之后发现文件夹里生成了许多网页和看不懂的东西 这里的index就是首页的意思

点进去发现是关于这个类的网页

点击这个类进去就能看到为这个类添加的文档注释信息 构造器 方法等等

以上就是用命令行生成javadoc文档的具体步骤

接下来是用idea生成javadoc文档的步骤

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 便能看生成的文档。