用IDEA生成文档注释

753 阅读1分钟

一、使用文档注释模板

作用是固定不变的注释不用每次手写,减少工作量。

1、类和接口注释

settings里面搜索File and Code Templates,按下图设置,接口注释同理。

image.png

2、方法注释

见此文

二、自定义JavaDoc标签

作用是自定义一些个性标签,供JavaDoc自动识别进说明文档中。原理是javadoc命令的-tag参数。

添加方法:在自定义标签上alt+Enter,添加到custom tags。

删除自定义标签,按下图操作:

image.png

三、生成说明文档

在Idea中的上方栏目中,找到 tools,打开菜单中的 Generate JavaDoc

参考:IDEA官网关于文档注释的说明