IDEA插件系列(29):Easy Javadoc插件——快速生成javadoc文档注释
Posted 二木成林
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了IDEA插件系列(29):Easy Javadoc插件——快速生成javadoc文档注释相关的知识,希望对你有一定的参考价值。
1.插件介绍
Easy Javadoc插件。
能帮助java开发者自动生成javadoc文档注释。如下:
2.安装方式
第一种安装方式是在线下载安装插件。
第二种安装方式是使用离线插件进行安装。
插件下载地址:https://plugins.jetbrains.com/plugin/12977-easy-javadoc
3.使用方法
可以直接查阅官方的使用说明,是中文文档。
Windows系统下的idea安装该插件后启动的默认快捷键如下:
快捷键 | 作用域 | 说明 |
---|---|---|
ctrl \\ | 类、方法、属性(光标放上面就行,不要双击选中!) | 生成当前文档注释 |
ctrl \\ | 选中的中文 | 生成选中的中文的英文命名 |
ctrl \\ | 选中的非中文 | 弹框展示翻译结果 |
ctrl shift \\ | 类 | 生成全部文档注释 |
注意,需要将光标放在方法名、变量名、类名的字符串中间(不要选中,因为选中会变成编译该单词)再按快捷键才会生效。如下图:
可以对文档注释中的作者名、日期格式等进行相关设置,还可以设置翻译媒介(如百度翻译、有道翻译等)。
还可以对类注释模板、方法注释模板、属性注释模板进行个性化配置。
例如做如下的自定义设置
效果如下:
如果它们的快捷键发生冲突,可以在Keymap面板中进行修改。
以上是关于IDEA插件系列(29):Easy Javadoc插件——快速生成javadoc文档注释的主要内容,如果未能解决你的问题,请参考以下文章