`java`学习笔记（十一）`javadoc`注释

最新推荐文章于 2023-09-13 14:14:50 发布

void.bug

最新推荐文章于 2023-09-13 14:14:50 发布

阅读量357

点赞数

分类专栏： java 文章标签： java 开发语言后端

空数据

本文链接：https://blog.csdn.net/qq_45205390/article/details/120893546

版权

本文详细介绍了Java中的Javadoc注释，包括其用途、命令用法、DOS命令生成API帮助文档的步骤，以及文档注释的格式规范。Javadoc是从源代码中抽取API文档的工具，主要处理类、接口、成员变量和方法的注释，生成与源代码配套的API文档。此外，文章还探讨了Javadoc标签的使用，包括块标签和内联标签的格式，并提醒开发者注意大小写敏感性和正确的位置放置。

摘要由CSDN通过智能技术生成

`java`学习笔记（十一）`javadoc`注释

文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。

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

API 帮助文档相当于产品说明书，而说明书只需要介绍那些供用户使用的部分，所以 Javadoc 默认只提取 public、protected 修饰的部分。如果要提取 private 修饰的部分，需要使用 -private。

`Javadoc`标签

标签	描述	示例
@author	标识一个类的作者，一般用于类注释	@author description
@deprecated	指名一个过期的类或成员，表明该类或方法不建议使用	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	可能抛出异常的说明，一般用于方法注释	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数，一般用于方法注释	@param parameter-name explanation
@return	说明返回