在 Debian 上使用 PhpStorm 代码模板
一 快速入口与概念
- 打开设置:依次点击 File → Settings(macOS 为 Preferences),或使用快捷键 Ctrl+Alt+S。
- 两类模板:
- 文件与代码模板 File and Code Templates:新建文件时自动生成骨架(如 PHP Class、Interface、HTML、JS 等)。
- 实时模板 Live Templates:编码中输入缩写后按 Tab 快速展开代码片段。
- 在设置页可用搜索框输入关键字如 templates 快速定位。以上菜单路径在 Debian 与 Windows/macOS 一致。
二 文件与代码模板使用
- 入口与位置:Editor → File and Code Templates,在 Files 与 Includes 标签页中查看、编辑、新增模板。
- 常用变量与指令:
- 变量示例:${PROJECT_NAME}、${FILE_NAME}、${NAME}、${USER}、${DATE}、${TIME}、${YEAR}、${MONTH}、${DAY}、${HOUR}、${MINUTE}、${PRODUCT_NAME}、${MONTH_NAME_SHORT}、${MONTH_NAME_FULL}。
- 指令与技巧:使用 #parse(“xxx”) 包含其它模板;在 PHP Includes 中可用 ${NAMESPACE}、${CLASS_NAME}、${STATIC}、${TYPE_HINT}、${PARAM_DOC}、${THROWS_DOC}、${DS}、${CARET} 等;需要字面量 $ 时使用 ${DS}。
- 快速示例(自定义 PHP 类模板):
三 实时模板 Live Templates 使用
- 作用与入口:在编码过程中输入缩写(如 fori、tryc)后按 Tab 快速展开代码片段。
- 创建步骤:
- 打开 Editor → Live Templates,点击右侧 + → Live Template。
- 填写:Abbreviation(缩写)、Description(描述)、Template text(模板内容)。
- 点击 Define,勾选适用上下文(如 PHP)。
- 点击 Edit variables 配置变量与表达式(如 capitalize、snakeCase 等),最后 Apply/OK。
- 常用示例
- try/catch(缩写:tryc)
try {
$END$
} catch (Exception $e) {
// TODO: handle exception
$END$
}
- for 循环(缩写:fori)
for ($i = 0; $i < ${ARRAY}.length; $i++) {
${ELEMENT} = ${ARRAY}[$i];
$END$
}
- 字符串包含判断(缩写:ifstrpos)
if (strpos(${HAYSTACK}, ${NEEDLE}) !== false) {
$END$
} else {
$END$
}
- 使用方式:在 PHP 文件中输入缩写(如 tryc、fori、ifstrpos),按 Tab 展开。
四 管理与共享模板
- 作用域与存储:
- 模板可在 项目级 或 全局(默认)级 配置;项目级便于团队共享,全局级对所有项目生效。
- 存储路径:
- 全局模板:config | fileTemplates
- 项目模板:.idea | fileTemplates
- 导入导出与复用:通过复制模板文本、导出/导入设置,或 Tools → Save File as Template 从现有文件快速生成模板,便于在团队内统一规范。