SuperAPI AI 工具集

create-oo-component-documentation

编程与开发

查看项目

更新于 10-15 21:52

技能介绍

用途:为指定路径下的面向对象组件生成全面、标准化的技术文档,面向开发者与维护者。分析范围:若路径为文件夹则分析全部源文件,若为单文件则视为主组件并分析与同目录相关文件。

主要能力:遵循 C4 模型(Context、Containers、Components、Code)、Arc42 模板、IEEE 1016 软件设计描述标准;识别类结构与继承、设计模式与架构决策;记录公共 API、接口与依赖、方法参数/返回值/异常;评估性能、安全、可靠性、可维护性;推断集成模式与数据流。针对 C#/.NET、Java、TypeScript/JavaScript、Python 提供语言特定优化。

使用方式:以 ${input:ComponentPath} 指定组件路径,按模板生成 Markdown,文档保存到 /docs/components/,命名为 [component-name]-documentation.md。文档含 front matter(title、component_path、version、date_created、last_updated、owner、tags)及组件概览、架构、接口、实现细节、用法示例、质量属性、参考信息等章节,并用 mermaid 图展示结构与依赖。

适用场景:为已有 OO 组件补写或规范化架构文档。限制:不处理不存在路径或缺失源文件(给替代位置建议);结构不清晰时记录发现并请求澄清;非标准模式按自定义方式记录;代码不足时聚焦已有信息并标注缺口。具体收费、依赖版本等未提供。