file-header-comments

Installation
SKILL.md

代码文件顶部注释规范

所有代码文件必须在文件顶部包含功能描述注释。


⚠️ 核心强制要求

注释内容(按优先级)

  1. 核心功能概述(必需):第一句话说明文件是干什么的
  2. 主要接口/功能(必需):列出主要函数/类
  3. 快速开始示例(推荐):最简单的使用示例

禁止事项

  • ❌ 详细描述架构分层
  • ❌ 重复代码中已明确的信息
  • ❌ 冗长的执行流程描述
Related skills

More from qiao-925/qiao-skills

Installs
17
First Seen
Feb 9, 2026