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} 当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。

第一步：在工具栏中找到 Tool，然后再子菜单中找到 Generate JavaDoc。

 

image

第二步：在生成文档上进行配置。

 

配置的简单介绍：

image

参数说明

1.Whole project:整个项目都生成文档

2.Custom scope 自定义范围。如下：

（1）project files 项目文件，

（2）project production files 项目产品文件，

（3）project test files 项目的测试文件， 未知范围，class hierarchy 类层

3.include test source 包含测试目录

4.include JDK and … 包含jdk和其他的第三方jar

5.link to JDK documentation…链接到JDK api

6.output directy 生成的文档存放的位置

（1）private、package、protected、public 生成文档的级别（类和方法）

（2）右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引..

（3）再右边是生成的文档包含的内容信息，作者版本等信息

7.Locale 语言类型,zh-CN

8.Other command line arguments 其他参数

9.Maximum heep… 最大堆栈

我这里的配置如下：

 

image

说明：IntelliJ IDEA作为Java流行的编辑器, 其生成一些Javadoc会对中文乱码, 使用UTF-8编码即可. 这个常见的问题, 则需要生成时设置参数即可.

在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 栏里输入 ：

传入JavaDoc的参数，一般这样写
-encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api

不然的话会报可能会报错误: 编码GBK的不可映射字符。

作者：逝者如斯灬
链接：https://www.jianshu.com/p/0ddb0864e499
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。