Fitten Code自定义代码块生成规则配置指南
如果你想让 Fitten Code 生成的代码更贴合自己的项目规范——比如函数必须带 JSDoc、类名强制 PascalCase、Python 函数默认加类型注解——那直接依赖默认模板是行不通的。得通过配置自定义代码块生成规则来实现。
不过,在动手之前,要确保 VS Code 版本 ≥ 1.68.0,并且已经登录了 Fitten Code(通过微信或邮箱都可以)。登录状态很关键,因为 settings.json 中的 rule 配置在未登录状态下是不会生效的,所有高级配置项都会灰掉。
确认这两点后,进入配置界面就很简单了。有两种方式:一是点击左侧 Fitten Code 图标,再点右上角的齿轮图标选择「Settings」;二是按下 Ctrl + , 在设置搜索框里输入「Fitten Code」,然后点击扩展列表中的「Configure extension settings」。这一步会直接跳转到 Fitten Code 的专属配置页,修改后实时生效,无需重启。
确认插件版本与登录状态
打开 VS Code → 左侧活动栏点击 Fitten Code 图标 → 查看右上角用户头像是否已点亮。未登录时所有高级配置项均置灰不可用。【必须先完成微信或邮箱登录,否则 settings.json 中的 rule 配置不会生效】
检查 VS Code 版本:Help → About → 确认版本号 ≥ 1.68.0。低于此版本无法加载 rule schema 校验器,保存后规则可能被静默忽略。
进入 Fitten Code 配置界面
方法一:点击左侧 Fitten Code 图标 → 右上角齿轮图标 → 选择「Settings」
方法二:Ctrl + ,(逗号)打开设置 → 搜索框输入「Fitten Code」→ 在扩展列表中点击「Fitten Code」右侧的「Configure extension settings」
这一步会自动跳转到 Fitten Code 专属配置页,不是通用 settings.json 编辑器。此处修改实时生效,无需重启。
添加自定义代码块规则
到了添加规则的步骤,需要填写三个必填字段。
第一步:在 Settings 页面找到「Code Generation Rules」区块,点击「+ Add Rule」。
第二步:依次填写:
• Language:下拉选择目标语言,比如 TypeScript、Ja va、Python。
• Trigger Pattern:输入触发该规则的注释前缀,例如 // @gen:api 或 /// @fnc。这里要特别留意,斜杠数量和空格必须完全匹配,区分大小写且不支持正则。写成 // @GEN:API 就无法匹配 // @gen:api。
• Template:粘贴你想要的代码结构,支持占位符 ${functionName}、${params}、${returnType} 等。示例如下:/**n * ${description}n */nexport function ${functionName}(${params}): ${returnType} {n // TODO: implementn throw new Error('Not implemented');n}
第三步:勾选「Enable this rule」,点击右上角「Sa ve」。此时规则立即加入运行时匹配队列。
在代码中调用自定义规则
规则配置好之后,调用起来有三种方式。
方法一(推荐):在任意空白行输入你设定的 Trigger Pattern,比如 // @gen:api,然后按下 Tab 键,Fitten Code 就会自动展开对应 Template 的代码块,并且光标会停在 ${functionName} 占位符处,方便你直接编辑。
方法二:选中已有注释行(含 Trigger Pattern),右键选择「Fitten Code – Generate from Comment」,AI 会按该规则补全下方代码。
方法三:使用快捷键 Ctrl+Alt+G,输入指令时带上规则标识,例如:“按 @gen:api 规则生成用户登录接口”,AI 会优先匹配并应用该规则。
