创建和编辑IntelliJ IDEA文件模板

由 Carrie 创建, 最后一次修改 2017-10-13

IntelliJ IDEA 创建文件模板

  1. 打开“设置/首选项”对话框,并在编辑器节点下选择文件和代码模板页面。
  2. 切换到 "文件" 选项卡。
  3. 单击工具栏上的 图标,并指定模板名称、文件扩展名和模板正文,该模块可以包含以下内容:
    • 纯文本。
    • #parse 指令与包含一起使用。
    • 要扩展为格式 $ {<variable_name>} 的相应值的预定义变量。
      可用的预定义文件模板变量是:
      • ${PACKAGE_NAME} - 将创建新类或接口的目标包的名称。
      • ${PROJECT_NAME} - 当前项目的名称。
      • ${FILE_NAME} - 将要创建的 PHP 文件的名称。
      • ${NAME} - 在创建文件的过程中,在 "新建文件" 对话框中指定的新文件的名称。
      • ${USER} - 当前用户的登录名。
      • ${DATE} - 当前系统日期。
      • ${TIME} - 当前系统时间。
      • ${YEAR} - 本年度。
      • ${MONTH} - 当月。
      • ${DAY} - 当月的当前日期。
      • ${HOUR} - 当前时间。
      • ${MINUTE} - 当前分钟。
      • ${PRODUCT_NAME} - 将在其中创建文件的 IDE 的名称。
      • ${MONTH_NAME_SHORT} - 月份名称的前3个字母。示例:1月,2月等。
      • ${MONTH_NAME_FULL} - 一个月的全名。示例:1月,2月等。
      IntelliJ IDEA 为 PHP 包括模板提供了一组附加变量,即可以包含在其他 PHP 文件模板内容中的可重用片段的模板。内置的 PHP 包含模板用于生成文件头和 PHPDoc 文档注释。下列变量在 PHP 包含模板中可用:
      • ${NAME} - 将为其生成 PHPDoc 注释的类、字段或函数(方法)的名称。
      • ${NAMESPACE} - 类或字段命名空间的完全限定名(无斜杠)。
      • ${CLASS_NAME} - 定义了生成 PHPDoc 注释的字段的类的名称。
      • ${STATIC}- 如果要为其生成注释的函数 (方法) 或字段为静态(static),则获取静态值。否则计算结果为空字符串。
      • ${TYPE_HINT}- 提示函数 (方法) 的返回值以生成注释。如果无法通过函数 (方法) 的静态分析检测到返回类型,则计算结果为 void。
      • ${PARAM_DOC} - 参数的文档注释。计算为一组 @param 类型名称的行。如果要为其生成注释的函数不包含任何参数,则该变量将计算为空内容。
      • ${THROWS_DOC} - 异常的文档注释。计算结果为一组 @throws 类型的行。如果要为其生成注释的函数不抛出任何异常,则该变量将计算为空内容。
      • ${DS}- 一个美元字符 ($)。该变量的计算结果为纯美元字符 ($),当您需要转义此符号时使用它,使其不被视为变量的前缀。
      • ${CARET} - 指出了在生成和添加评论后插入符号的位置。
        仅当在创建文件期间生成并插入 PHPDoc 注释时,才应用此变量。当 PHPDoc 注释是通过代码| 生成| PHPDoc 块(Code | Generate | PHPDoc block)创建的, 可以使用多个函数或方法的选择,因此文档注释可以创建到几个类、函数、方法或字段。因此,IntelliJ IDEA 无法“选择”块来应用 ${CARET} 变量,因此在这种情况下,该 ${CARET} 变量将被忽略。
    • 自定义变量。它们的名称可以通过 #set 指令在模板中定义,也可以在文件创建过程中进行定义。
  4. 若要将美元字符 ($) 放在呈现为 "as" 的变量中,请改用 ${DS} 变量。此变量的计算结果为纯美元字符 ($)。
  5. 应用更改并关闭对话框。

IntelliJ IDEA 从现有文件夹创建文件模板

  1. 打开 "文件模板设置" 页并切换到 "文件" 选项卡。
  2. 单击工具栏的 图标,根据需要更改模板名称、扩展名和源代码。
  3. 应用更改并关闭对话框。

IntelliJ IDEA 从文件创建文件模板

  1. 在编辑器中打开所需的文件。
  2. 在主菜单上选择工具|将文件另存为模板(Tools | Save File as Template)。
  3. 在 "文件和代码模板" 对话框中指定新模板的名称,并在必要时编辑源代码。
  4. 应用更改并关闭对话框。

IntelliJ IDEA 创建和引用包含模板

IntelliJ IDEA 中包含模板用于通过 #parse 指令定义要插入到文件模板中的可重用代码段。

  1. 在 "文件和代码模板设置" 页中,切换到 "包含" 选项卡。
  2. 单击工具栏的 图标,并指定模板名称、扩展名和源代码。执行以下操作之一:
    • 使用预定义的文件模板变量。
    • 创建自定义模板变量,并使用 #set VTL 指令在包含(include) 模板中直接定义它们的值 。例如,如果要在文件头中插入您的全名,而不是通过 $ {USER} 定义的登录名,则编写以下结构:
      #set( $MyName = "John Smith" )
      如果在应用模板时,某些模板变量的值未知,IntelliJ IDEA 将要求您指定它们。
    • 您可以防止将模板变量中的美元字符 ($) 作为前缀处理。如果您需要一个美元字符(插入值为 $),请改用 $ {DS} 文件模板变量。当应用模板时,此变量的计算结果为纯美元字符 ($)。
    • 若要使用 "包含" 模板,请切换到 "模板" 选项卡,选择所需的模板,并单击“编辑”。
    • 要包含模板,请在源代码中插入 #parse 指令。
课工场赞助广告-前端必学技能
二维码
建议反馈
二维码