AGENT SKILL

file-header-guardian

文件头三行契约注释。触发:create file、新建文件、编写代码。

License 许可
MIT
最近更新
2026-06-24
Stars
★ 66
Forks
24

01 前言 Front Matter

name
file-header-guardian
description
文件头三行契约注释。触发:create file、新建文件、编写代码。

02 资源文件 68

03 SKILL.md 正文

文件头注释守护者

触发:创建代码文件,修改文件后检查头注释准确性。

模板

TS/JS:

/**
 * @input  依赖什么
 * @output 提供什么
 * @pos    系统地位
 * ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
 */

Python:

"""
@input  依赖什么
@output 提供什么
@pos    系统地位
⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
"""

Shell:

# @input  依赖什么
# @output 提供什么
# @pos    系统地位
# ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md

示例

/**
 * @input  prisma.service 数据库连接
 * @output UserService: create/update/delete
 * @pos    用户模块核心
 * ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
 */
export class UserService { }

豁免

配置文件(json/yaml)、样式(css)、生成文件(*.d.ts)、node_modules。

协作:本 skill 管文件,fractal-docs-generator 管目录。

04 同仓库更多 Skills