JavaDoc生成文档

JavaDoc生成文档

什么是JavaDoc？

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

JavaDoc标签

标签	说明	JDK 1.1 doclet	标准doclet	标签类型
@author 作者	作者标识	√	√	包、 类、接口
@version 版本号	版本号	√	√	包、 类、接口
@param 参数名	描述方法的入参名及描述信息，如入参有特别要求，可在此注释。	√	√	构造函数、 方法
@return 描述	对函数返回值的注释	√	√	方法
@throws异常类名	构造函数或方法所会抛出的异常。		√	构造函数、 方法
@since 描述文本	API在什么程序的什么版本后开发支持。	√	√	包、类、接口、值域、构造函数、 方法

生成自己的开发文档（两个方法）

方法一(命令行生成)

1. 简单写一个类，加上文档注释。

   
   /**
    * @author peng
    * @version 1.0
    * @since 1.8
    */
   public class Doc {
   
       String name;
   
       /**
        * @author peng
        * @param name
        * @return
        * @throws Exception
        */
       public String test(String name) throws Exception{
           return name;
       }
   }
   
   

2. 打开这个类的路径
   

   

3. 在这个目录下打开命令行

4. 用javadoc命令来运行刚刚我们写的Doc类。
   在命令行写：javadoc -encoding UTF-8 -charset UTF-8 Doc.java（-encoding UTF-8 -charset UTF-8：这是参数，防止生成乱码之类的。

   

最后打开该目录文件
会发现生成了一堆东西，但是只需看index.html，双击打开，既可以看到生成的文档了。
如下图所示：

双击后，可以看到文档。

方法二(用idea生成文档)

步骤如下：

1. 

2. 

   解释一下：

   1. 选择是整个项目还是模块还是单个文件
   2. 文档输出路径
   3. Locale 选择地区，这个决定了文档的语言，中文就是zh_CN
   4. 传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

   可以看到控制台的输出：

   

3. 这里我输出在桌面的javadoc帮助文档文件夹中：打开并找到index.html，双击打开就可以看到了。