centos上phpstorm如何使用代码模板

在 CentOS 上使用 PhpStorm 代码模板

一 核心概念与入口

• PhpStorm 的代码模板分为两类：
  1. 文件代码模板 File and Code Templates：新建文件时生成初始代码骨架；
  2. 动态模板 Live Templates：编码中输入缩写并按 Tab 展开代码片段。
• 打开设置：依次点击 File → Settings（macOS 为 Preferences），常用入口为：
  • 文件模板：Editor → File and Code Templates
  • 动态模板：Editor → Live Templates
• 在 CentOS 上界面与快捷键与 Windows/macOS 基本一致，仅快捷键修饰键不同（如 Ctrl+Alt+S 打开设置）。

二 创建与使用文件代码模板

• 新建或编辑模板：进入 Editor → File and Code Templates，在 Files 或 Includes 页签中新建/编辑模板。模板支持 Velocity Template Language（VTL），可使用变量与指令。
• 常用变量示例：
  • 通用：${PROJECT_NAME}、${FILE_NAME}、${NAME}、${USER}、${DATE}、${TIME}、${YEAR}、${MONTH}、${DAY}、${HOUR}、${MINUTE}、${PRODUCT_NAME}
  • PHP 包含模板专用：${NAMESPACE}、${CLASS_NAME}、${STATIC}、${TYPE_HINT}、${PARAM_DOC}、${THROWS_DOC}、${DS}（输出字面量 $）、${CARET}（生成后光标位置）
• 典型 PHP 类模板示例：

  <?php
  #parse("PHP File Header.php")
  #if (${NAMESPACE})
  namespace ${NAMESPACE};
  #end
  class ${NAME} {
  }
  

• 使用方式：通过 File → New 创建对应类型文件（如 PHP Class），即会自动套用模板；也可在设置中调整 Applicable in 以限定适用范围。

三 创建与使用动态模板

• 新建模板：进入 Editor → Live Templates，先新建或选择一个 Template Group，再点击 + 新建模板，填写：
  • Abbreviation（缩写，如：pubf）
  • Template Text（模板主体，使用 $变量名$ 定义可编辑区域）
  • 点击 Edit Variables 配置变量（可用表达式，如 capitalize(String)），并设置 Applicable in 指定生效的语言/上下文
• 预定义变量：$END$（展开后光标位置）、$SELECTION$（环绕模板时代表选中内容）
• 使用方式：在代码编辑区输入缩写（如 pubf）后按 Tab 展开；若启用环绕（如选中文本后用 Ctrl+Alt+T 选择模板），可用 $SELECTION$ 包裹选中内容。
• 从现有片段创建：在编辑器中选中代码 → Tools → Save as Live Template，按提示完善缩写与变量。

四 实用示例

• 示例一 文件模板自定义文件头（Includes）
  • 新建包含模板（如：PHP File Header.php），内容：

    /**
     * @author    ${USER}
     * @date      ${DATE} ${TIME}
     * @project   ${PROJECT_NAME}
     */
    

  • 在 PHP Class 模板首行加入：#parse(“PHP File Header.php”)，新建类时将自动生成文件头。
• 示例二 Live Template 快速生成 public function
  • 缩写：pubf
  • 模板文本：

    public function ${NAME}($${PARAMS}) {
        ${BODY}
    }
    

  • 变量建议：NAME 提示输入；PARAMS 可留空或设置默认值；BODY 设为 $END$。在类中输入 pubf + Tab 即可生成函数骨架。

五 管理与排错

• 作用域与生效：模板只有在 Applicable in 指定的语言/上下文才会出现；若未展开，请检查该处配置与当前文件类型。
• 变量与字面量 $：模板中需要输出字面量 $ 时，使用 ${DS}；变量编辑在 Edit Variables 中完成。
• 重置与恢复：对修改过的模板可在列表右键选择 Restore defaults 恢复；内置（内部）模板不可删除。
• 方案与共享：模板有 项目级 与 全局（默认）级 两种作用域；全局模板位于 IDE 配置目录的 fileTemplates，项目模板位于 .idea/fileTemplates，便于团队共享。