当前位置:   article > 正文

IDEA插件系列(3):Easy Javadoc插件——快速生成javadoc文档注释

easy javadoc

1.插件介绍

Easy Javadoc插件。

能帮助开发者快速生成类、方法、属性等中文javadoc
在这里插入图片描述

2.安装方式

第一种安装方式是在线下载安装插件。
在这里插入图片描述
第二种安装方式是使用离线插件进行安装。

插件下载地址:https://plugins.jetbrains.com/plugin/12977-easy-javadoc
在这里插入图片描述

3.使用方法

可以直接查阅官方的使用说明,是中文文档。

默认快捷键(可通过IDEA快捷键设置修改)
win
快捷键作用域说明
ctrl \类、方法、属性(光标放上面就行,不要双击选中!)生成当前文档注释
ctrl \选中的中文生成选中的中文的英文命名
ctrl \选中的非中文弹框展示翻译结果
ctrl shift \生成全部文档注释
mac
快捷键作用域说明
command \类、方法、属性(光标放上面就行,不要双击选中!)生成当前文档注释
command \选中的中文生成选中的中文的英文命名
command \选中的非中文弹框展示翻译结果
command shift \生成全部文档注释

注意,需要将光标放在方法名、变量名、类名的字符串中间(不要选中,因为选中会变成编译该单词)再按快捷键才会生效。如下图:
在这里插入图片描述
可以对文档注释中的作者名、日期格式等进行相关设置,还可以设置翻译媒介(如百度翻译、有道翻译等)。
在这里插入图片描述
类注释模版

/**
 * 类名称:$CLASSNAME$
 *
 * 描述:$DOC$
 * 创建人: $AUTHOR$ 
 * 创建时间: $DATE$
*/
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

在这里插入图片描述

方法注释模版

/**
 * $DOC$
 *
 * $PARAMS$ 
 * $RETURN$
 * @author $AUTHOR$ 
 * @date $DATE$
*/
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

在这里插入图片描述
如果它们的快捷键发生冲突,可以在Keymap(按键映射)面板中进行修改。
在这里插入图片描述

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/盐析白兔/article/detail/112106?site
推荐阅读
相关标签
  

闽ICP备14008679号