利用live templates和File and Code Templates快速生成代码或注释以及解释它们的区别；解释模板变量和expression表达式的含义；解决csdn无法输出$$的问题。

灰太狼 2023-09-28 16:01 20阅读 0赞

#### 目录 ####

*  File and Code Templates
 *   *  使用模板原因
     *  如何使用模板
     *  变量解释
     *  生成代码
 *  live templates
 *   *  使用模板原因
     *  如何使用模板
     *   *  创建模板组【template group】，比如我创建的是myTemplate
         *  在模板组下创建模板【live template】
         *  变量解释
     *  生成注释
     *   *  弹出框Edit Template Variables的字段解释
         *  Expression表达式的字段解释
 *  细节提醒
 *   *  File and Code Templates和live templates变量区别
     *  解决csdn无法输出$$

大部分开发人员，不论是前端，还是后端，应该会使用`jetbrains`的编辑器，比如前端的`web storm`，后端的`idea`、`Goland`，其提供了快速生成代码和代码注释的工具，即`live templates`和`File and Code Templates`。

## File and Code Templates ##

### 使用模板原因 ###

我们希望在创建java文件时，便将开发者姓名、创建时间，类信息描述等便一起写入，此时，我们可以利用\`\`\`\`File and Code Templates\`\`\`帮我们做这件事。

### 如何使用模板 ###

我的电脑是window系统，Windows可以如此来设置：File - > Settings -> Editor -> File and Code Templates，如图所示：  
![File and Code Templates截图][File and Code Templates]

### 变量解释 ###

就类似于`${USER}`这样的字段做如下解释：

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>${PACKAGE_NAME}</td> 
   <td>创建类所在的包名称</td> 
  </tr> 
  <tr> 
   <td>${NAME}</td> 
   <td>你在弹出框中的类名称</td> 
  </tr> 
  <tr> 
   <td>${USER}</td> 
   <td>用户系统登录名</td> 
  </tr> 
  <tr> 
   <td>${DATE}</td> 
   <td>系统日期</td> 
  </tr> 
  <tr> 
   <td>${TIME}</td> 
   <td>系统时间</td> 
  </tr> 
  <tr> 
   <td>${YEAR}</td> 
   <td>本年</td> 
  </tr> 
  <tr> 
   <td>${MONTH}</td> 
   <td>本月</td> 
  </tr> 
  <tr> 
   <td>${MONTH_NAME_SHORT}</td> 
   <td>本月的前三个字母【针对英文月份】，比如Jan【一月】, Feb【二月】</td> 
  </tr> 
  <tr> 
   <td>${MONTH_NAME_FULL}</td> 
   <td>本月的全名【针对英文月份】，比如January(一月), February(二月)等</td> 
  </tr> 
  <tr> 
   <td>${DAY}</td> 
   <td>当天</td> 
  </tr> 
  <tr> 
   <td>${HOUR}</td> 
   <td>本小时</td> 
  </tr> 
  <tr> 
   <td>${MINUTE}</td> 
   <td>当前分钟</td> 
  </tr> 
  <tr> 
   <td>${PROJECT_NAME}</td> 
   <td>本项目名称</td> 
  </tr> 
 </tbody> 
</table>

### 生成代码 ###

如上设置好`File and Code Templates`，于是区创建一个`Test.java`类  
![创建类][232c482c31f94dbba144d69dbfa4f6a1.png]

新创建的`Test.java`代码，自动生成了作者名和当前时间，如下所示：

package com.example.demo.demo;
    
    /**
     * @author zhangsan
     * @datetime 2022/7/20 17:41
     * @desc 这是一个测试类
     */
    public class Test {
        
    }

如果想要自动生成其他信息，可以参考表格中的字段，自行设置。

## live templates ##

### 使用模板原因 ###

我们在创建代码时，可以使用File and Code Templates帮我们自动生成注释，但我们有时想要自动生成类似如下的代码：

输入main 生成 public static void main(String[] args) {
         }
    
    输入sout 生成  System.out.println();
    
    输入fori 生成  for (int i = 0; i < ; i++) {
        }
    
    ...

此时，我们可以使用`live templates`，执行如下步骤，来制定某种规则，帮我们快速生成代码，如下图解释。

### 如何使用模板 ###

#### 创建模板组【template group】，比如我创建的是myTemplate ####

![模板组][51f35f0f10774a7b9e89d60644f3c2a5.png]

#### 在模板组下创建模板【live template】 ####

我想实现输入`try`，即可输出这样的代码：

try{
        
             
     } catch (Exception e) {
        
          log.error("error",e);
    }

因而，我们可以在`live templates`这样配置：  
![live templates][]

#### 变量解释 ####

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Abbreviation</td> 
   <td>即你想要缩写的词，比如上文中的 try</td> 
  </tr> 
  <tr> 
   <td>Description</td> 
   <td>描述当前缩写词的的意思，比如输入try，列出try-catch</td> 
  </tr> 
  <tr> 
   <td>Template text</td> 
   <td>此处缩写模板，比如 try{$action$} catch (Exception e) {log.error(“error”,e);$end$ }</td> 
  </tr> 
 </tbody> 
</table>

### 生成注释 ###

当然，Template text旁边有个`Edit variables`按钮，改按钮是用来定义变量的，这是什么意思呢？

比如，我想要输入`fun`即可实现方法注释，因而，我可以这样设计：

/**
     * @author $user$ 
     * @datetime $date$:$time$
     * @desc
     */

此时，单击`Edit variables`，即出现下图的弹出框：  
![在这里插入图片描述][7c87e8b18b464c039eb772cc9406db7e.png]

#### 弹出框Edit Template Variables的字段解释 ####

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Name</td> 
   <td>你所定义的变量名，比如 $user$</td> 
  </tr> 
  <tr> 
   <td>Expression</td> 
   <td>变量对应的表达式，比如user()输出本电脑的用户名，date()输出当天日期</td> 
  </tr> 
  <tr> 
   <td>Default Value</td> 
   <td>默认值，如果没有选择表达式，则会使用默认值输出</td> 
  </tr> 
  <tr> 
   <td>Skip if defined</td> 
   <td>此复选框可让 IntelliJ IDEA 继续处理下一个输入字段，前提是定义了当前输入字段的值</td> 
  </tr> 
 </tbody> 
</table>

#### Expression表达式的字段解释 ####

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>user()</td> 
   <td>返回系统登录名</td> 
  </tr> 
  <tr> 
   <td>time()</td> 
   <td>返回当前日期</td> 
  </tr> 
  <tr> 
   <td>annotated(“annotation qname”)</td> 
   <td>创建带有指定位置注释的类型符号。</td> 
  </tr> 
  <tr> 
   <td>arrayvariable()</td> 
   <td>建议适用于当前范围的所有数组变量。例如，在迭代组中查看活动模板。</td> 
  </tr> 
  <tr> 
   <td>anonymoussuper()</td> 
   <td>提出一种科特林级对象表达类型。</td> 
  </tr> 
  <tr> 
   <td>сamelcase（字符串）</td> 
   <td>返回作为参数传递的字符串，转换为骆驼格。例如，我的文本文件/我的文档/ my_text_file将转换为mytextfile。</td> 
  </tr> 
  <tr> 
   <td>capitalizeandunderscore（scamelcasename）</td> 
   <td>利用CamelCase的名称作为参数传递的所有信件，并插入一个下划线之间的部分。例如，如果一个参数是要通过字符串，然后返回foo_bar。</td> 
  </tr> 
  <tr> 
   <td>casttoleftsidetype()</td> 
   <td>将右侧表达式投射到左侧表达式类型。它在迭代组中使用一个模板来生成原始类型和泛型集合。</td> 
  </tr> 
  <tr> 
   <td>className（sclassname）</td> 
   <td>返回当前类的名称（扩展模板的类）。</td> 
  </tr> 
  <tr> 
   <td>classnamecomplete()</td> 
   <td>这个表达式替换变量位置上的类名完成。</td> 
  </tr> 
  <tr> 
   <td>clipboard()</td> 
   <td>返回系统剪贴板的内容。</td> 
  </tr> 
  <tr> 
   <td>camelCase（字符串）</td> 
   <td>返回字符串的字符串snake_case camelCase。例如，如果一个参数是foo_bar通过字符串，然后返回foobar。</td> 
  </tr> 
  <tr> 
   <td>complete()</td> 
   <td>这个表达式替换了变量位置上的代码完成调用。</td> 
  </tr> 
  <tr> 
   <td>completesmart()</td> 
   <td>该表达式替代变量位置上的智能类型完成调用。</td> 
  </tr> 
  <tr> 
   <td>componenttypeof（&lt;数组变量或数组类型&gt;）</td> 
   <td>返回数组的组件类型。例如，在其他组中的迭代组中查看活动模板。</td> 
  </tr> 
  <tr> 
   <td>currentpackage()</td> 
   <td>返回当前包名。</td> 
  </tr> 
  <tr> 
   <td>date()</td> 
   <td>以指定格式返回当前系统日期。默认情况下，当前日期是以默认的系统格式返回</td> 
  </tr> 
  <tr> 
   <td>decapitalize（SNAME）</td> 
   <td>用相应小写字母替换作为参数传递的名称的第一个字母。</td> 
  </tr> 
  <tr> 
   <td>descendantclassenum（&lt;字符串&gt;）</td> 
   <td>显示类的子字符串作为参数输入。</td> 
  </tr> 
  <tr> 
   <td>enum（scompletionstring1，scompletionstring2，…）</td> 
   <td>建议在模板调用中完成的逗号分隔字符串列表。</td> 
  </tr> 
  <tr> 
   <td>escapestring（sescapestring）</td> 
   <td>转义指定字符串。</td> 
  </tr> 
  <tr> 
   <td>expectedtype()</td> 
   <td>返回作为整个模板的结果所期望的类型。如果模板在赋值的右边，在返回之后扩展，则是有意义的。</td> 
  </tr> 
  <tr> 
   <td>fileName()</td> 
   <td>以扩展名返回文件名。</td> 
  </tr> 
  <tr> 
   <td>filenamewithoutextension()</td> 
   <td>返回没有扩展名的文件名。</td> 
  </tr> 
  <tr> 
   <td>firstWord（sfirstword）</td> 
   <td>返回作为参数传递的字符串的第一个单词。</td> 
  </tr> 
  <tr> 
   <td>groovyscript（“Groovy代码”）</td> 
   <td>用指定的代码返回Groovy脚本。你可以使用多个参数的groovyscript宏。第一个参数是执行的脚本文本或包含脚本的文件路径。接下来的参数绑定到_1，_2，_3，…_n变量都可以在你的脚本。同时，_editor变量可在脚本。此变量绑定到当前编辑器。</td> 
  </tr> 
  <tr> 
   <td>guesselementtype（&lt;集装箱&gt;）</td> 
   <td>对存储在一个java.util.collection元素类型的猜测。猜想，IntelliJ IDEA试图找到地方的元素被添加到或从容器中提取。</td> 
  </tr> 
  <tr> 
   <td>iterablecomponenttype（&lt; arrayoriterable &gt;）</td> 
   <td>返回一个组件类型，如数组或集合。</td> 
  </tr> 
  <tr> 
   <td>iterablevariable()</td> 
   <td>返回可以重复的变量的名称。</td> 
  </tr> 
  <tr> 
   <td>linenumber()</td> 
   <td>返回当前行号。</td> 
  </tr> 
  <tr> 
   <td>lowercaseanddash（字符串）</td> 
   <td>返回以破折号分隔的小写字符串，作为参数传递的字符串。例如，字符串转换为我的名字MyExampleName。</td> 
  </tr> 
  <tr> 
   <td>methodname()</td> 
   <td>返回拥抱方法的名称（在模板扩展的地方）。</td> 
  </tr> 
  <tr> 
   <td>methodparameters()</td> 
   <td>返回方法（扩展模板）的参数列表。</td> 
  </tr> 
  <tr> 
   <td>methodreturntype()</td> 
   <td>返回当前方法返回的值的类型（扩展模板的方法）。</td> 
  </tr> 
  <tr> 
   <td>qualifiedclassname()</td> 
   <td>返回当前类的完全限定名称（扩展模板的类）。明显缩短FQ名称”复选框。</td> 
  </tr> 
  <tr> 
   <td>rightsidetype()</td> 
   <td>用右侧表达式的类型声明左侧变量。它在迭代组中使用一个模板来生成原始类型和泛型集合。</td> 
  </tr> 
  <tr> 
   <td>snakecase（scamelcasetext）</td> 
   <td>从CamelCase返回snake_case字符串字符串作为参数传递。</td> 
  </tr> 
 </tbody> 
</table>

## 细节提醒 ##

### File and Code Templates和live templates变量区别 ###

live templates的变量定义和File and Code Templates不一样，File and Code Templates是`${variable_name}`定义变量，而live templates使用 `$variable_name$`定义变量

### 解决csdn无法输出$$ ###

![在这里插入图片描述][7aa53602a64d4f728deeb9c0a37afeb9.png]  
如果这样输入$user$，csdn无法输出`$`符号，因而，我们需要使用转义字符，如图所示：  
![转义字符][c957873dab9d4cd48add042fe4a4569b.png]

[File and Code Templates]: https://img-blog.csdnimg.cn/57280ab6bbaa4183a30c293c128f9538.png
[232c482c31f94dbba144d69dbfa4f6a1.png]: https://img-blog.csdnimg.cn/232c482c31f94dbba144d69dbfa4f6a1.png
[51f35f0f10774a7b9e89d60644f3c2a5.png]: https://img-blog.csdnimg.cn/51f35f0f10774a7b9e89d60644f3c2a5.png
[live templates]: https://img-blog.csdnimg.cn/0ca62965b39a4c799dcbc833ccf14c7b.png
[7c87e8b18b464c039eb772cc9406db7e.png]: https://img-blog.csdnimg.cn/7c87e8b18b464c039eb772cc9406db7e.png
[7aa53602a64d4f728deeb9c0a37afeb9.png]: https://img-blog.csdnimg.cn/7aa53602a64d4f728deeb9c0a37afeb9.png
[c957873dab9d4cd48add042fe4a4569b.png]: https://img-blog.csdnimg.cn/c957873dab9d4cd48add042fe4a4569b.png