如何使用IDEA生成javadoc文档

javadoc介绍

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

​ javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。

javadoc常用标记

标签	说明
@author 作者	作者标识
@version 版本号	版本号
@param 参数名描述	方法的入参名及描述信息，如入参有特别要求可在此注释
@return 描述	对函数返回值的注释
@deprecated 过期文本	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API
@throws 异常类名	构造函数或方法所会抛出的异常
@exception 异常类名	同@throws
@see 引用	查看相关内容，如类、方法、变量等
@since 描述文本	API在什么程序的什么版本后开发支持
{@link包.类#成员 标签}	链接到某个特定的成员对应的文档中
{@value}	当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值

使用IDEA来生成javadoc文件

1. 在上方导航栏中点击Tools，然后再点击Generate JavaDoc
   

2. 之后看到如下页面
   

   Output directory：生成的javadoc文档存放的位置。可以自己定义

3. 在Locale中填入：zh-CN

   在Other command line arguments 中填入以下内容：-encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api
   如果不这么填写则会报错：编码GBK的不可映射字符

   之后点击OK后我们就可以在之前Output directory中定义的目录下查看到生成的javadoc文档了