Python 官方文档：入门教程 => 点击学习
目录一、概述二、类注释模板1、File-->settings-->Editor-->File and Code Templates-->Files三、方法注释
IDEA自带的注释模板一般都很简单，然而我们在写代码的时候喜欢把类注释和文档注释写在代码里，既方便自己看所有的参数，也便于以后维护代码的时候看到编码作者。下面是我的代码注释，我们就按照这种格式来设置：
类注释模板：
方法注释模板：
（1）@BelongsProject：当前项目的名称
（2）@BelongsPackage：当前包的名称
（3）@Author：作者姓名（可以写死，写成你的名字）
（4）@CreateTime：该类创建的时间
（5）@Description：对该类的描述（该类的功能）
（6）@Version：设置版本号，一般新创建的类都是1.0版本，这里写死就可以了
IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，我们的习惯是
点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere-->Java即可
（如果曾经修改过，则显示为change而不是define）
把右侧的Expand with：改为Enter ；然后选择右侧的Edit variables按钮
PS:第4步和第5步顺序不可颠倒，否则第5步将获取不到方法
1、IDEA格式的模板只需要为每个参数选择对应的方法即可
2、设置成功后点击OK，返回项目新建一个方法，写完入参和返回值以后，在方法上面：
敲出：
（2）参数设置（JavaDoc格式的需要自定义参数以及返回值的实现方式）
获取参数实现方式：
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())返回值实现方式：
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return: ' + \"${_1}\"", methodReturnType())如果返回值不想有报名，可以使用下面这个参数：
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';}; def p1=params[i].split(',').toList(); for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList(); result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','} } ; }; return result", methodReturnType())（3）设置成功后点击OK，返回项目新建一个方法，写完入参和返回值以后，在方法上面：
敲出：/** 回车
然后会显示：（注意不一样的地方）
大家可以根据自己的爱好和风格去设置！！！
到此这篇关于IDEA类与方法注释模板设置的文章就介绍到这了,更多相关IDEA类与方法注释模板设置内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！
--结束END--
本文标题: IDEA类与方法注释模板设置图文教程(非常详细)
本文链接: https://www.lsjlt.com/news/166606.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
下载Word文档到电脑，方便收藏和打印～
2024-03-01
2024-03-01
2024-03-01
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
官方手机版
微信公众号
商务合作
0