idea 打开class 没有注释_idea 类注释 方法注释

本文档详细介绍了如何在IDE中配置文件和代码模板,以快速生成类和方法的注释。通过调整SettingsEditor,可以在创建新类时自动添加描述、作者和创建日期的注释。同时,设置了方法注释的Live Templates,使得添加方法注释更加便捷。教程中还提供了处理参数对齐问题的方法,并给出了生成注释的快捷键操作步骤。
摘要由CSDN通过智能技术生成

一 生成类注释

打开Settings

20180923142439474257.png

Editor -> File and Code Templates -> Files -> Class ,在类名上面添加所需注释即可。

20180923142439717405.png

示例如下:

/**

* @description: ${description}

*

* @author: ${USER}

*

* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}

**/

附 生成接口等其他类步骤相似,如下所示

20180923142439960554.png

二  生成方法注释  ---> 设定注释格式再设置方法注释的快捷键

打开Live Templates

点击右边加号为自己添加一个Templates Group

然后选中自己的Group再次点击加号添加Live Templates

20180923142440124606.png

参照下图继续设置。

20180923142440346271.png

快捷键内容->方法注释内容如下:红字部分不要修改 第一行不要带 /*  为了注释美观   否则变为/*/*注释内容

如果没有对齐,自行添加空格即可。

@Description: $description$*@Author: $user$*@Date: $date$ $time$

$params$*@return: $returns$*/

如果复制形式如下:

20180923142440532783.png

那么解决办法:手动去除空格

20180923142440620668.png

$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())

最后 按 /**回车即可,如果设置的是Enter ,如下所示。

20180923142440731989.png

没有对齐的话,自行增删空格。编写博文时,方法注释对齐良好。

20180923142440950725.png

设置应用场景 (未设置过的话如下图,点击1  ,接着点 2 或3  或其他)

20180923142441068881.png

接着 Apply 再OK即可。

20180923142441180202.png

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值