Android Studio(IDEA)设置代码注释模板
设置类注释
打开Setting,选择Editor - File and Code Templates,最后是File中的Class,点击Class后,在右侧的模板中进行编辑;
之后可根据需要进行其他文件模板的修改;
下面是类注释模板的实例。在新建类时,需要提前输入description,之后就会创建成功;
1 | /** |
设置方法(函数)注释
打开 Setting,选择 Editor - Live Templates,在右侧+号选择 Template Group;
选中刚刚新建的 MyTemplates,再点击右侧+号选择 Live Template;
在下方 Abbreviation 填写模板缩写,Description填写模板描述,然后输入模板;
下面是方法注释模板的实例;
1 | /** |
填写模板后,点击右侧的 Edit Variables 进行参数配置;
param的参数:
1 | groovyScript("def result='';def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();def types=\"${_2}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++){def p1=types[i].split(',').toList();def p3='';for(i2=0;i2<p1.size();i2++){def p2=p1[i2].split('\\\\.').toList();p3=p2[p2.size()-1];};result+=' * @param ' + p3 + ' ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')};return result",methodParameters(),methodParameterTypes()) |
return的参数:
1 | 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()) |
最后在代码中输入/add,回车或Tab键即可使用;
Kotlin设置方法(函数)注释
以上方法无法生成Kotlin的方法注释,需要另外安装 Kdoc-generator 插件;
在 Settings - Plugins - Marketplase 中可以找到;
在Kotlin代码中输入 /** + 回车 即可使用;
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 泉子的理想乡!
评论