青岛做网站皆赴青岛博采网络,嘉兴 网站制作,福州网站排名优化,淘宝搜券的网站怎么做文章目录 1 概要2 类的自定义模版注释3 自定义模版注释3.1 方法的自定义模版注释3.2 属性的自定义模版注释 #x1f64a; 前言#xff1a;在Java开发中#xff0c;注释具有不可或缺的重要性#xff0c;注释负责解释代码#xff0c;能帮助开发人员深入理解代码的逻辑和功能… 文章目录 1 概要2 类的自定义模版注释3 自定义模版注释3.1 方法的自定义模版注释3.2 属性的自定义模版注释 前言在Java开发中注释具有不可或缺的重要性注释负责解释代码能帮助开发人员深入理解代码的逻辑和功能可以提高代码的可读性使其他开发者能更容易地理解和使用你的代码。而IDEA中自带的默认注释模板过于简单所以本文将带大家设置IDEA自定义的类和方法注释的模版 1 概要 根据《Java开发手册》(九) 注释规约第一条中强制规定了类、类属性、类方法的注释必须使用 Javadoc 规范使用/** 内容*/格式不得使用// xxx 方式。这样可以是开发者在 IDEA中工程调用方法时不进入方法即可悬浮提示方法、参数、返回值的意义提高阅读效率。而在《Java开发手册》(九) 注释规约第三条中强制规定所有的类都必须添加创建者和创建日期如下图所示 而IDEA中默认给出的注释模版生成的注释过于简单没有创建者、创建日期等信息但我们可以通过设置IDEA中的模版注释设置自定义自动生成的注释模版下图为博主设置的类和方法的注释模版示例效果 在其它类中调用方法rayTest就可以看到如下所示的效果 除了编程规约中强制约定的创建者、创建日期这两个信息是固定的其它信息如版本号等可以自定义设置。以上示例图是博主的习惯仅供参考请大家自定义模版 2 类的自定义模版注释 在设置中快捷键ctrlalts搜索或者直接如上图找到File and Code Templates设置项输入自定义内容也可以直接复制如下代码记得修改作者名
/*** 描述** author LiaoYuXing-Ray* version 1.0* createDate ${DATE} ${TIME}**/1️⃣ author 作者名必备注释项可以像博主一样写成死字符串也可以使用函数获取当前计算机用户名 author ${USER} 请注意大小写 2️⃣ version 版本号可选注释项建议像博主一样写死1.0因为新创建的类没什么特殊情况下就是 1.0 版本 3️⃣ createDate 创建时间必备注释项根据规约强制日期的设置统一为yyyy/MM/dd 的格式。所以我们使用函数 ${DATE} ${TIME} 表示即可至于你喜欢叫date或者createDate还是其它的都行但建议不要使用中文 3 自定义模版注释 在设置中快捷键ctrlalts搜索或者如下图找到Live Templates设置项点击号新建模版组2 Template Group… 输入模版组的名字并点击OK由于博主已经创建了Ray模版组所以OK选项是灰色的如下图所示 接下来可以在新建的模版组中添加你希望自定义的模版如方法/** 内容 */、属性 /* 内容 */的模版。 以下步骤必须一致不然可能存在问题 3.1 方法的自定义模版注释 1️⃣选择你刚刚创建的模版组然后点击号新建模版1 Live Template如下图所示 2️⃣设置Abbreviation的值为** 这个值是后续快速插入模版使用的召唤值可以自定义 3️⃣设置Description的值为方法注释可以自定义
) 4️⃣设置Template text的值如下代码由于格式非常容易打错建议直接复制粘贴后再按自己需求修改
*** $end$*$param$* return $return$* author LiaoYuXing-Ray $date$ $time$**/5️⃣如下图所示点击下方的Define第一次定义该模版或者Change已定义过该模版现在为修改设置该模版的使用场景 第一次定义某个模版点击Define设置该模版的使用场景如下图所示 6️⃣设置该模版的使用场景找到Java项进行勾选如下图所示 7️⃣点击Edit variables如下图所示 8️⃣在弹出的Edit Template Varibles中填入对应的方法建议直接复制粘贴图下的代码尤其是param非常易错再点击OK如下图所示 // param
groovyScript(def result;def params\${_1}\.replaceAll([\\\\[|\\\\]|\\\\s],).split(,).toList(); for(i 0; i params.size(); i) {if(params[i] ) continue;if(i0) result * param params[0] ((params.size()1)?:\\n);else{ result * param params[i] ((iparams.size()-1)?\\n:)}};return result,methodParameters())// return
methodReturnType()// date
date()// time
time() 此步骤非常重要出错会直接导致自定义模版函数不会生效 9️⃣选择Options中的Expand with修改为Space可自定义如下图所示 此步骤是设置召唤模版的快捷键自定义模版的使用是通过步骤2️⃣中设置的 Abbreviation的值如** 加上 本步骤设置的快捷键即Space空格键的组合召唤模版。 IDEA默认使用的是Enter即使用 /** 加 回车键Enter即可快捷进行方法注释但博主喜欢使用Space空格键因为这样设置很方便就能打出方法注释也许是博主的手太小了按Enter不方便总之请按照自己的习惯自定义 最后一步也是最关键的一步请记得按❗️Apply❗️ 现在我们可以愉快的在方法上使用 /** 空格 召唤我们自定义的方法模版注释了 3.2 属性的自定义模版注释 由于属性和方法的设置基本一致甚至更简单所以部分图片就不再展示 1️⃣选择刚刚创建的模版组然后点击号新建模版1 Live Template 2️⃣设置Abbreviation的值为* 可以自定义 3️⃣设置Description的值为属性注释可以自定义 4️⃣设置Template text的值如下代码由于格式非常容易打错建议直接复制粘贴后再按自己需求修改
*** $end$ $date$ $time$*/5️⃣点击下方的Define或者Change设置该模版的使用场景 6️⃣设置该模版的使用场景为Everywhere由于属性注释是通用的所以博主直接勾选Everywhere当然你也可以自定义勾选使用场景 7️⃣点击Edit variables 8️⃣在弹出的Edit Template Varibles中下拉选择填入对应的方法再点击OK如下图所示 9️⃣选择Options中的Expand with修改为Space可自定义 最后一步记得按❗️Apply❗️
现在我们可以愉快的在属性上使用 /* 空格 召唤我们自定义的属性模版注释了效果如下 如果需要修改模版主要修改第4️⃣步中的Template text的内容如果使用函数要记得在Edit variables中设置 本文是博主的粗浅理解可能存在一些错误或不完善之处如有遗漏或错误欢迎各位补充谢谢 如果觉得这篇文章对您有所帮助的话请动动小手点波关注你的点赞收藏⭐️转发评论都是对博主最好的支持~
