notes

Installation
SKILL.md

notes

这个 skill 用于写代码注释。注释默认写给刚接手当前模块、还不熟悉调用链的人。读者不应先研究完整实现和内部术语,才能看懂注释。

只有任务涉及注释治理时才使用它。普通 React、后端或 SQL 开发任务不应仅因为出现这些技术栈就触发;如果用户要求检查当前改动是否缺少必要注释,可以使用。

规范读取要求

通用注释规则已经写在本文件内。执行注释相关任务时,先应用本文件规则,再按场景读取补充文档。

  • 涉及前端、React、Hook、组件、事件处理、渲染分支时,再读 references/frontend.md
  • 涉及 Node.js 后台、controller、service、SQL、任务、队列、外部接口时,再读 references/backend.md

通俗易懂

先用日常动词说明最终效果,再补确实影响理解的原因。不要把代码前提、内部机制、操作对象和最终结果全部塞进一句注释。

Installs
107
First Seen
May 10, 2026
notes — jybill/xqv-skills