IntelliJ IDEA 插件,自动生成 javadoc 文档注释
本项目是IntelliJ IDEA的插件,能帮助java\kotlin开发者自动生成javadoc\kdoc文档注释
支持的IDEA版本为 2023.1 及以上
支持给中文起名字,类似程序员起名神器
打开IntelliJ IDEA -> plugins,java搜索Easy Javadoc,安装重启即可
ctrl \或者command \,即可生成注释,你的方法名起的越贴切,注释越得体。 ctrl shift \或者command shift \,即可批量生成文档注释。(Kdoc暂不支持)ctrl \或者command \,即可自动变成英文,类似程序员起名神器。ctrl \或者command \,即弹出选中的翻译结果,再也不用在词典和IDEA之间来回切换了。@return {@code User}@return {@code Map<String, Integer>}@return {@link User}@return {@link Map}<{@link String}, {@link Integer}>当然,翻译不准的情况很常见,如果是因为单词翻译错误,可以在配置页面对自己的单词进行配置,自定义翻译的优先级大于其他。
各个翻译每月都有免费额度,基本够用了。需要自己申请相关秘钥等
打开配置页面
可看到相关配置
ctrl \
类、方法、属性(光标放上面就行,不要双击选中!)
生成当前文档注释
ctrl \
选中的中文
生成选中的中文的英文命名
ctrl \
选中的非中文
弹框展示翻译结果
ctrl shift \
类
生成全部文档注释
command \
类、方法、属性(光标放上面就行,不要双击选中!)
生成当前文档注释
command \
选中的中文
生成选中的中文的英文命名
command \
选中的非中文
弹框展示翻译结果
command shift \
类
生成全部文档注释
Comis Sans MSMonacoctrl \ )不生效检查:
这是因为IDEA的默认格式化将单行转成了多行,需要更改IDEA的格式化设置
这是因为IDEA的默认格式化将文档标签顺序改了,如果非得要自定义的顺序的话,则需要改IDEA如下设置
package-info.java@return {@code User}@return {@code Map<String, Integer>}@return {@link User}@return {@link Map}<{@link String}, {@link Integer}>如果觉得插件很赞,为你节约了不少时间,那么就请作者喝杯咖啡吧~☕☕☕
暂无开放 Issues,或尚未同步最近议题。