AgentSkillsCN

comment

为指定源码添加中文注释,覆盖自定义函数、自定义变量、解构变量、以及 JSX 内每个自定义组件,注释说明其作用/功能。

中文原作
SKILL.md
--- frontmatter
name: comment
description: 为指定源码添加中文注释,覆盖自定义函数、自定义变量、解构变量、以及 JSX 内每个自定义组件,注释说明其作用/功能。

注释提示语规则(代码注释)

适用场景

当用户要求“给某个文件加注释”,且要求注释对象包含:

  • 自定义函数
  • 自定义变量
  • 解构的变量
  • JSX 内每个自定义组件 并且注释内容是“注释对象的作用/功能”。

产出原则

  • 用简洁中文说明“做什么/用途是什么”。
  • 不改变代码逻辑,仅新增注释。
  • JSX 内注释必须使用 {/* ... */};TS/JS 使用 //
  • 若 JSX 顶层不能直接插入注释,使用 Fragment 包裹。

注释覆盖清单

  1. 自定义函数:在函数定义前加 // 说明职责。
  2. 自定义变量:在变量声明上方加 // 说明用途。
  3. 解构变量:在解构对象内为每个字段加行内注释说明用途。
  4. JSX 自定义组件:在组件标签前添加 {/* ... */} 说明组件作用。
  5. 对象字面量 key:在返回或构造的大对象中,为每个 key 添加注释说明用途。

输出格式

  • 直接修改原文件,保持现有代码风格与格式。
  • 不新增无关注释,不引入额外逻辑。