调用Javadoc程序生成自己项目的API文档

最新推荐文章于 2025-07-14 10:43:53 发布

原创

最新推荐文章于 2025-07-14 10:43:53 发布 · 2k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#Java #Javadoc #生成API

本文详细介绍了如何使用Javadoc为Java项目生成API文档。内容包括Javadoc注释的规则，如只在public类和方法上使用，以及文档注释的格式。文章还提供了生成API文档的具体步骤，包括在MyEclipse中导出Javadoc，选择目标路径，以及处理可能出现的编码问题。最后，展示了生成的API文档结构和内容，证实了注释信息已正确转化为文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

想要生成自己项目的AIP文档，首先你要先给自己的项目添加特殊注释，什么特殊注释呢？在Java中有三种注释，分别是单行注释、多行注释、文档注释。这个特殊注释就是文档注释，添加这个注释是为了能够生成与之对应API文档，你在注释中输入的信息就是生成的API里面的信息。注释写好之后调用Javadoc程序完成代码与文档的分离然后生成API文档。
Javadoc程序有一些生成API文档的相关规则，只有符合这些规则才能生成正确的API文档。文档注释也有一些相关的注释标签，下面是生成API文档的相关规则说明和相关的注释标签：
生成API文档的规则：

Javadoc针对public类生成注释文档
Javadoc只能在public、protected修饰的方法或者属性之上
Javadoc注释的格式化：前导*号和HTML标签
Javadoc注释要仅写在类、属性、方法之前

注释标签：

标签	说明	标签类型
@author 作者	作者标识	包、类、接口
@version 版本号	版本号	包、类、接口
@param 参数名描述	方法的入参名及描述信息，如入参有特别要求，可在此注释	构造函数、方法
@return 描述	对函数返回值的注释	方法
@deprecated 过期文本	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API	包