IDEA自动生成代码注释
注释就是对代码的解释和说明。目的是为了让别人和自己很容易看懂，一看就知道这段代码是做什么用的。正确的程序注释一般包括序言性注释和功能性注释。序言性注释的主要内容包括模块的接口、数据的描述和模块的功能。模块的功能性注释的主要内容包括程序段的功能、语句的功能和数据的状态。
IDEA自动生成类注释
1.打开idea-->选择File-->选择settings
2.设置类注释
3.新建测试类，模拟注释自动生成
IDEA自动生成方法注释
1.打开idea-->选择File-->选择settings
2.创建Template Group，取名为MethodAnnotation
3.选中MethodAnnotation，创建Live Template
4.编辑Live Template，在Template text中输入一下注释模板。
*
* TODO: $date$ $time$ 请添加方法描述
*
* $VAR1$
$params$* @return $returns$
* @author A_GallopingSnail
* @date $date$ $time$
* @update_by A_GallopingSnail
* @update_at $date$ $time$
* @creed Talk is cheap, show me the comment !!!
*/5.勾选所有代码适用选项
6.点击EDIT VARIABLES并编辑，其中VAR1输入以下groovy脚本，并保存。
groovyScript("
def result='';
def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
def paramTypes=\"${_2}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
for(i = 0; i < params.size(); i++) {
if(i!=0)result+= ' * ';
result+='@param ' + params[i] + ' ' + paramTypes[i] + ((i < (params.size() - 1)) ? '\\n' + '\\t' : '');
};
return result", methodParameters(), methodParameterTypes())7.在方法的上一行输入/**，然后在输入tab键，最后一路按下enter键
有一个关于程序员的段子，说所有的程序员都讨厌两件事，一是别人不写注释，二是自己写注释。关于写注释，一直有人争论不休，有的人认为写代码必须要写注释，而又的人认为代码就是注释，何必再写一遍？希望本文可以对你有所帮助。
本文参与 腾讯云自媒体同步曝光计划，分享自微信公众号。
原始发表：2021-09-11，如有侵权请联系 cloudcommunity@tencent.com 删除
评论
登录后参与评论
推荐阅读
目录
腾讯云开发者
