Javadoc生成的详细操作教程

所有知识体系文章，GitHub已收录，欢迎Star！

GitHub地址： https://github.com/Ziphtracks/JavaLearningmanual

搜索关注微信公众号“码出Offer”，Z哥送你学习福利资源！

Javadoc文档

一、什么是Javadoc文档

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

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

二、Javadoc文档注释

Java注释分类：

• //注释内容：单行注释，不支持换行
• /*注释内容*/：多行注释，支持换行
• Javadoc文档注释格式如下，支持换行，可以生成Javadoc文档【重点】

/**
 * 文档注释
 */

三、常用注释文档标记

参考官方文档： javadoc - The Java API Documentation Generator

常用标签	说明
@author 作者	作者标识
@version 版本号	版本号
@param 参数名 描述	方法的入参名及描述信息，如入参有特别要求，可在此注释。
@return 描述	对函数返回值的注释
@deprecated 过期文本	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。
@throws异常类名	构造函数或方法所会抛出的异常。
@exception 异常类名	同@throws。
@see 引用	查看相关内容，如类、方法、变量等。
@since 描述文本	API在什么程序的什么版本后开发支持。
{@link包.类#成员 标签}	链接到某个特定的成员对应的文档中。
{@value}	当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。
不常用标签	说明
@serial	说明一个序列化属性
@serialField	说明一个ObjectStreamField组件
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据
{@docRoot}	指明当前文档根目录的路径
{@inheritDoc}	从直接父类继承的注释
{@literal}	显示文本而不将其解释为HTML标记或嵌套的javadoc标记。
{@code}	以字体 显示文本，code而不将文本解释为HTML标记或嵌套的Javadoc标记。

四、Javadoc选项说明

Javadoc命令格式： javadoc [选项] [软件包名称] [源文件]

4.1 选项说明

选项	说明
-overview	<文件> 读取 HTML 文件的概述文档
-public	仅显示公共类和成员
-protected	显示受保护/公共类和成员（默认）
-package	显示软件包/受保护/公共类和成员
-private	显示所有类和成员
-help	显示命令行选项并退