SuperAPI AI 工具集

notes

前端与建站

查看项目

更新于 10-15 23:43

技能介绍

用途:这个 skill 专门用于写代码注释,面向刚接手当前模块、不熟悉调用链的读者。只有任务涉及注释治理时才使用;普通 React、后端或 SQL 开发任务不应仅因技术栈出现而触发。若用户要求检查当前改动是否缺少必要注释,可以使用。

主要能力:提供注释决策流程与通用判断表,覆盖导出函数与 class static 方法(写简短 JSDoc,说明业务用途、关键入参或返回含义)、for/if 控制流(默认在块上方写一行总结,说明业务产出、过滤边界、状态优先级、状态推进或副作用顺序)、多变量准备后紧跟逻辑处理(逐变量注释其职责,逻辑块说明过滤、分支边界或优先级)、复杂判断、状态流转、SQL 口径、异步副作用、模型协议边界、相似字段映射等场景。简单赋值、普通取字段、明显空值回退、普通按钮点击不写注释。

使用方式:写入前先润色并核对全部待写入文字。humanizer-zh skill 可用时必须调用并完整读取应用其 SKILL.md;不可用时按大白话规则完成检查并继续写入,回报中说明采用了大白话规则,不声称调用过该 skill。处理范围包括本次写入的全部注释、JSDoc、注释规范和其他说明文字。代码、标识符、命令、路径、URL、链接目标、结构化数据、JSDoc 标签和类型声明保持原样,只润色说明文字。涉及前端、React、Hook、组件、事件处理、渲染分支时读 references/frontend.md;涉及 Node.js 后台、controller、service、SQL、任务、队列、外部接口时读 references/backend.md。

限制:不写“获取某某”“设置某某”“返回某某”“处理某某”这类表面注释,不逐字段解释,不写长段落,一条注释只讲一个重点。空行只用于分隔不同业务阶段或控制流,保留空行则其后代码块上方需有组注释,写不出就删掉空行。具体安装命令、收费与平台信息暂未提供。