SuperAPI AI 工具集

front-comments

前端与建站

查看项目

更新于 10-15 21:37

技能介绍

用途:为当前打开或用户明确指定的前端文件添加结构化注释,默认应用 Level 1(仅结构注释),若参数包含 full 则应用 Full(Level 1 加行内注释)。支持 JS、TS、React(JSX/TSX)、CSS、Sass、HTML、Vue、Svelte、Astro。

主要能力:先扫描并移除文件中所有现有注释,识别其中包含非显而易见信息、业务规则、浏览器兼容处理、工单引用、架构决策或“为什么”解释的有价值注释,再按结构化规则重新生成注释,并把有价值信息融入新的文件头、JSDoc 描述或行内注释中,避免信息丢失。

使用方式:根据目标文件扩展名加载同目录下的子文件(如 front-comments-js.md、front-comments-css.md、front-comments-html.md、front-comments-vue.md、front-comments-svelte.md、front-comments-astro.md)并执行其中规则。注释语言由参数决定:lang:fr 为法语,lang:es 为西班牙语,lang:de 为德语,否则默认英语。

输出规则:输出完整文件不截断;不修改任何现有代码,只添加注释;保留原有格式、缩进与空行。JS/TS 仅用 /** / 写 JSDoc 与行内注释,// 仅用于分节分隔;CSS/SASS/SCSS 用 / / 作分节分隔与三级标签,用 /* */ 写文件头、主要分节描述与行内属性组标签。

限制:资料未提供安装命令、收费方式、平台支持范围及具体子文件规则细节。