开发工具IDEA——增加注释快捷按键和jsdoc使用手册

2022-03-25 18:02:50 阅读：301 来源： 互联网

标签：return image IDEA 开发工具 jsdoc result params 使用手册

安装和jsdoc使用手册

http://www.wuweigang.com/?id=302

开发工具IDEA——增加注释快捷按键

简介

开发工具IDEA系列文章是我在进行Java开发时使用IDEA开发工具一些设置和其调整，特将其整理出来分享给大家，特别适合于刚接触开发或者刚重新安装开发工具的小伙伴们，可以根据这一系列文章将IDEA工具调校成为自己的左膀右臂，助力自己的Java开发。

环境

系统：windows10
开发工具：IDEA
语言：Java

内容

之前我进行设置了开发工具IDEA——创建类或方法注释，但是有时我们的类文件或者方法已经存在了，我只是想补充一下注释，这时我们就需要使用到快捷键进行注释了，对此，我们需要配置一个符合于我们自己注释格式的快捷键，下面我们就开始进行配置。

1、打开IDEA进入File——Setting——Editor——Live Templates

点击右侧的+号，选择Template Group模板分组添加

image-20210916141039204

image-20210916141155600

2、选择刚添加的分组，再次点击右侧的+号，选择Live Template进行添加一个代码模板，并添加基础信息

image-20210916141832775

其中Template text使用的代码如下，可根据自己的需求进行灵活调整。

**
* <p> </p>
* @date $data$ $time$
$params$
* @return $return$
* @throws $throws$
* @version 1.0
* @author $user$
*/

3、点击Edit variables 进行设置刚才在Template text中使用的一些变量对应的值或方法。

image-20210916142041932

image-20210916142558400

其中params使用的是如下自定义方法：

groovyScript("def result='';  def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();  for(i = 0; i < params.size(); i++)  {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

4、进行设置触发方式为回车Enter

image-20210916142908275

5、进行设置生效的范围

image-20210916142955786

image-20210916143003002

到达这里，我们就可以在方法上方进行实现输入/***然后按下回车键实现注释根据方法进行生成了。

下面我再次分享一下我设置的用于方法快捷键和用于类注释快捷键的模板内容

方法函数

**
* <p> </p>
* @date $data$ $time$
$params$
* @return $return$
* @throws $throws$
* @version 1.0
* @author $user$
*/

image-20210916143430667

groovyScript("def result='';  def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();  for(i = 0; i < params.size(); i++)  {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

类头部

**
 * 类 {@code $NAME$} 补充名称 <br> 补充简述.
 *
 * Copyright (c) 版权所有 <a href="https://blog.cnhuashao.com">CN華少</a><br>
 * @since v1.0.0
 * @version v1.0.1 $data$ $time$
 * @author <a href="mailto:lz2392504@gmail.com">$user$</a>
 * @see 相关联的类，每个类或方法单独一个@see标签
 * @TODO 代办事项的标记
 */

image-20210916143652483

标签：return,image,IDEA,开发工具,jsdoc,result,params,使用手册
来源： https://www.cnblogs.com/webSnow/p/16055958.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9