用途:为未编写文档或文档不完善的代码库生成准确、贴合上下文的文档,支持多个层级。
主要能力: 1)内联级:函数/方法文档,支持 JSDoc、Python docstring、Go doc 注释、Javadoc、Rust /// 等语言惯例; 2)模块级:README 或模块头注释,说明模块用途与导出; 3)架构级:说明模块交互、数据流与关键设计决策; 4)上手指南:面向新成员。
函数文档会提取:目的、参数(名称、类型、说明、默认值、约束)、返回值、副作用(数据库写入、API 调用、文件 I/O、状态变更、缓存失效)、异常/错误、示例用法。对复杂逻辑添加内联注释,解释“为什么”而非“做什么”,包括条件中的业务规则、性能关键部分、规避手段及非显而易见的算法选择。架构文档会映射模块依赖、识别入口点、追踪关键数据流、记录配置与环境变量、列出外部依赖、标注设计模式。
使用方式:在需要文档化代码、添加 JSDoc/docstring 或创建架构文档时调用本技能。质量规则:不陈述显而易见之事;记录契约而非实现;示例使用真实值;对过于复杂的函数先建议重构;文档过程中发现疑似缺陷应指出;无测试的模块需注明行为系由代码推断。
限制:资料未提供具体的命令行用法、安装方式、收费与价格信息。