IDEA设置类和方法注释模板（转载）

最新推荐文章于 2024-12-30 16:21:19 发布

转载最新推荐文章于 2024-12-30 16:21:19 发布 · 297 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://blog.youkuaiyun.com/engerla/article/details/119254597

文章标签：

#java #开发语言

本文详细介绍了在IntelliJ IDEA中设置方法和类注释模板的步骤，包括添加模板组、配置注释内容、指定适用文件类型及参数取值，帮助开发者提高代码注释效率，遵循阿里巴巴编码规范。

原文地址：IDEA设置方法注释模板_布丁吖的博客-优快云博客_idea方法注释模板设置

感谢了作者辛苦整理。

第一步、File -> Settings

第二步、选择“Editor”->“Live Templates”。

第三步、点击右侧的“+”->"Template Group…"添加组

第四步、命名组

第五步、点击右侧的“+”->"Live Template"添加组。

第六步、配置注释模板。

方法注释模板：

** TODO
 * @description 
 * @author liz
 * @date $date$ $time$ 
$param$
 * @return $return$
**/

类注释模板：

**
 * @className $name$
 * @description TODO
 * @author liz
 * @date $date$ $time$
 * @version 2.0
 **/

⑤设置在哪些文件中应用此注释模板

⑥设置模板中参数的取值

param使用这个比较符合阿里巴巴的规范插件的扫描

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) ? '\\r\\n' : '')}; return result", methodParameters()))

第七步、最后别忘了点击“Apply”和“OK”保存设置。