IntelliJ IDEA中创建自己的代码模板

  • Post author:
  • Post category:其他




  1. IDE settings

    (Ctrl+Alt+s),选择打开

    Live Templates

    页面, 展开需要查看的模板组;
  2. 可以选择一个已有模板点击“Edit”进行修改,或者点击“Add”进行新模板的创建;


  3. Edit Live Template

    对话框中,可以修改模板的缩写(Abbreviation);


  4. Template Text

    区域,可以编辑模板主体,包括普通文本和变量;变量以美元符‘$’开头和结尾(如$TYPE$),如果需要修改变量,可以点击”Edit Variables”按钮;


  5. Options

    区域, 我们可以指定模板如果被展开或者重新格式化;


  6. Context

    区域, 我们可以说明模板的语言以及在哪些编辑器需要识别模板的缩写;
  7. 修改完成后点击”OK”按钮即可;

同时,我们也可以直接从正在编辑的文本片段来生成模板,步骤如下:

  1. 在编辑器中,选择用于创建模板的文本片段;
  2. 在主菜单中,选择

    Tools | Save as Live Template,会出现


    Edit Live Template

    对话框;


  3. Abbreviation

    区域输入新模板的缩写;
  4. 输入模板主体,定义变量,模板组和相应选项;
  5. 修改完成后点击”OK”;

在编辑模板变量的时候,即在点击”Edit Variables”后的”Edit Template Variables”对话框中,可以看到对变量的修改有四个属性,分别为名称(Name),表达式(Expression), 默认值(Default value)和如果变量已经定义是否略过(Skip if defined);

  1. 名称(Name),即在模板主体中变量的名称,不包括开头和结尾的$符号;
  2. 表达式(Expression),指定变量的表达式,它会自动计算相应的模板输入域;可以直接输入或者在下拉列表中选择预定义的函数;下拉列表中同时说明了函数参数的数量和类型(如果有的话);
  3. 默认值(Default value),指明一个字符串作为变量的的默认值,如果在扩展开的模板中,表达式在计算后没有给出任何结果,则模板会使用这个默认值;这个值只有在已经为变量指定了一个表达式的时候才会被使用;
  4. 如果变量已经定义是否略过(Skip if defined),如果选中这个选项,当模板展开后,变量已经有一个经过表达式计算后生成的值或一个默认值时,则直接略过,跳到下一个输入域上供用户编辑;
  5. 对话框右侧有两个按钮,分别为”Move Up”和”Move Down”,用于调节变量的上下顺序;而变量的上下顺序决定了在模板展开后,编辑器在相应输入域之间切换的顺序;

IntelliJ IDEA为我们提供了一些非常有用的函数,以下列举一二:


  1. capitalize(<name>)

    ,将传入的参数首字母大写;

  2. className(),模板展开时所处的类的名称;

  3. date(),当前日期;

  4. iterableVariable(),可以进行迭代的变量的名称;

  5. complete(),在变量的位置进行代码补全的调用;

IntelliJ IDEA提供了超过三十个函数,在使用的时候可以参考在线的帮助文档或是IntelliJ IDEA中预定义的那些模板;