메뉴
代码注释补充与规范化专家，自动识别代码文件类型，为函数、类、方法、属性等代码元素添加专业双语注释。当用户提及"添加注释"、"补充注释"、"规范化注释"、"代码注释"、"annotate code"、"add comments"或需要为代码添加文档注释时使用本技能。本技能也可被其他技能（如 executing-plans）在代码完成后自动调用。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
项目上下文管理技能，用于管理用户画像和项目上下文。本技能由 brainstorming 和 executing-plans 技能调用，不独立触发。在 brainstorming 激活时调用以获取用户画像，在 executing-plans 完成时自动更新项目上下文。
Execute before any creative work — including creating features, building components, adding functionality, or modifying behavior. Explore user intent, requirements, and design solutions before implementation. Transform ideas into complete design specifications through natural collaborative dialogue. Activate when user mentions "new feature", "build", "create component", "add functionality", "implement", or starts any development work. This skill automatically invokes the project-context skill to obtain user profile and workflow path recommendations.
Code annotation supplementation and standardization expert. Automatically identifies code file types and adds professional bilingual comments for functions, classes, methods, properties, and other code elements. Activate when user mentions "add comments", "supplement comments", "standardize comments", "code comments", "annotate code", "add comments", or needs documentation comments for code. This skill can also be automatically invoked by other skills (such as executing-plans) after code is completed.
Use when there is a written implementation plan to execute in the session. Load the plan, review it, execute all tasks, and report upon completion. Activate when user mentions "execute plan", "implement plan", "run plan", "start execution", or when a plan document is ready for implementation.
Project context management skill for managing user profiles and project context. This skill is invoked by brainstorming and executing-plans skills, not triggered independently. Invoked to get user profile when brainstorming is activated, automatically updates project context when executing-plans completes.
Implementation plan creation skill for multi-step tasks. Use when there are specifications or requirements, before directly touching code. Create detailed, executable implementation plans. Activate when user mentions "create plan", "implementation plan", "write plan", "plan", "task breakdown", or starts complex multi-step development work with existing specifications.
| name | code-commentator |
| description | 代码注释补充与规范化专家，自动识别代码文件类型，为函数、类、方法、属性等代码元素添加专业双语注释。当用户提及"添加注释"、"补充注释"、"规范化注释"、"代码注释"、"annotate code"、"add comments"或需要为代码添加文档注释时使用本技能。本技能也可被其他技能（如 executing-plans）在代码完成后自动调用。 |
| license | MIT |
| metadata | {"version":"1.2.0"} |
本技能提供代码注释的系统性补充与规范化处理能力，自动识别代码文件类型，应用相应的注释规范，确保生成的注释准确、完整且符合双语要求。
当检测到以下情况时，主动激活此技能：
用户直接调用：
其他技能自动调用：
executing-plans 技能在任务完成后自动调用（如果代码需要注释）当被 executing-plans 或其他技能调用时：
接收参数：
target_files：需要添加注释的文件路径列表（必需）comment_priority：注释优先级（可选：high/medium/low）focus_areas：重点注释区域（可选：如"公共API"、"核心逻辑"）执行模式：
严禁修改任何代码内容。本技能只能添加或修改注释，不得：
唯一允许的操作：为代码添加注释或修改现有注释。
所有注释必须同时包含中英文双语说明，格式为：
详细的多语言注释格式示例已迁移到 references 目录：
| 参考文件 | 内容 |
|---|---|
| comment-formats.md | 各种编程语言的注释格式代码示例 |
| writing-style.md | 语气与口吻规范、语言语法要求 |
| quality-checklist.md | 注释质量验证清单 |
重要：添加注释前，先阅读 comment-formats.md 确保使用正确的语言格式。
以下代码元素必须添加多行文档注释：
仅在代码逻辑不够直观时才添加单行注释：
代码本身已足够清晰，无需添加注释：
if (isValid)）for (const item of items)）const userName = user.name）添加注释前，先问自己：
如果以上问题的答案表明代码已足够清晰，则不需要添加注释。
| 元素类型 | 插入位置 | 要求 |
|---|---|---|
| 函数/方法注释 | 紧贴在函数声明上方 | 不留空行 |
| 类注释 | 紧贴在类声明上方 | 不留空行 |
| 属性注释 | 紧贴在属性声明上方 | 不留空行 |
| 单行注释 | 放在代码行上方 | 与代码保持相同缩进 |
函数/方法注释必须包含：
当参数为联合类型时，必须详细说明每个类型：
@param input - The input data to process. Can be:
- `string`: A string value to parse / 要解析的字符串值
- `Buffer`: A buffer containing raw data / 包含原始数据的缓冲区
- `ReadableStream`: A stream to read data from / 要读取数据的流
支持多种传参方式时，提供不同场景的使用示例：
@example
// Create user with name only
const user = createUser('John');
// Create user with options object
const user = createUser({ name: 'John', age: 25, email: 'john@example.com' });
处理过程中实时报告进度：
## 注释处理进度
### 已完成 (3/10)
- ✅ src/utils/helper.ts (添加了 5 个函数注释)
- ✅ src/models/user.ts (添加了 2 个类注释, 8 个属性注释)
- ✅ src/api/client.ts (添加了 3 个函数注释)
### 处理中
- 🔄 src/services/auth.ts
### 待处理 (6/10)
- ⏳ src/config/index.ts
- ...
/**
* English description of the function.
*
* 中文描述函数的功能。
*
* @param paramName - English description / 中文描述
* @returns English description / 中文描述
* @throws {ErrorType} English description / 中文描述
* @example
* const result = functionName('value');
*/
function functionName(paramName: string): Result {}