notes

Installation
SKILL.md

notes

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

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

写入前的可读性检查

每次新增或更新内容,必须先润色并核对全部待写入文字。humanizer-zh skill 可用时,必须调用它,完整读取并应用其 SKILL.md。当前任务已读取且文件未变化时可以沿用;不可用时,按下述大白话规则完成检查并继续写入。

处理范围包括本次写入的全部注释、JSDoc、注释规范和其他说明文字。先按本 skill 判断哪里需要注释、注释应说明什么,再按上述规则润色草稿,核对含义后写入。不能只润色最终回复或部分注释。

保留业务含义、条件、否定、顺序和确定程度。代码、标识符、命令、路径、URL、链接目标、结构化数据,以及 JSDoc 标签和类型声明保持原样,只润色其中的说明文字。写入后再次修改文字时,修改部分也须经过同样处理。

humanizer-zh 不可用时,用常用词和短句说明谁在做什么、为什么这样做、结果是什么;必要术语用普通语言解释,删去空话和重复,不添加未经证实的信息。按刚接手模块的读者视角通读,确认无需先研究完整实现也能理解。继续完成写入,并在回报中简短说明采用了大白话规则,不声称调用过该 skill。

规范读取要求

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

Installs
120
First Seen
May 10, 2026