JavaDoc生成API文档

最新推荐文章于 2023-06-28 15:11:07 发布

原创最新推荐文章于 2023-06-28 15:11:07 发布 · 191 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #intellij-idea #servlet

JavaDoc是一种用于创建API文档的工具，它通过解析Java源代码中的特定注释来生成文档。主要注解包括@author, @version, @since, @param, @return和@throws。生成JavaDoc可以通过命令行或IDEA完成。在命令行中，使用`javadoc -encoding UTF-8 -charset UTF-8 文件名.java`；在IDEA中，设置输出目录、选择中文（zh_CN）并添加编码参数。完成后，index.html即为生成的API文档。

JavaDoc

JavaDoc命令是用来生成自己API文档的

参数信息

@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

如何生成JavaDoc文档

1. 使用命令行生成JavaDoc文档

javadoc -encoding UTF-8 -charset UTF-8 文件名.java

2. 使用IDEA生成JavaDoc文档

点击菜单栏 ----->Tools ----->Generate JavaDoc…
弹出的界面中,Output directory 选择自己的保存目录

Locale 框中输入 zh_CN ，这个就代表中文

Other command line arguments 框中输入这行代码

**-encoding utf-8 -charset utf-8 **

在这里插入图片描述