SuperAPI AI 工具集

doc-generator

通用与其它

查看项目

更新于 10-16 08:45

技能介绍

用途:为代码生成较完整的文档,包括 JSDoc/TSDoc、接口文档、README、API 参考与 CHANGELOG。触发词涵盖“document this”“add docs”“create README”“generate API docs”“add JSDoc”等。

主要能力:支持函数与接口注释模板,README 结构(项目名、徽章、Features、Installation、Quick Start、API Reference、Configuration、Contributing、License),以及 CHANGELOG 版本分组(Added、Changed、Fixed、Deprecated、Removed、Security)。

工作流:先用 grep -r "^export function" src/ | grep -v "/**" 找出未文档化的函数,再逐个阅读实现、理解用途、编写描述、补充参数与返回值、添加示例。验证可用 npx typedoc --validation 检查 TypeScript 文档,用 npx eslint --rule 'jsdoc/*' src/ 做文档 lint。

最佳实践:注释写“为什么”和用途,避免逐行复述代码;公开 API 需有示例、参数、返回值与错误说明,并同步维护 README 与 CHANGELOG。

限制:资料未说明具体实现语言绑定、安装方式、命令行入口或是否收费;源 URL 为 https://www.skills.sh/shunsukehayashi/miyabi/doc-generator。