用途:Documentation Generator 是一个文档生成技能,用于根据代码自动生成文档,覆盖函数级注释与项目级说明,包括 JSDoc、Python docstring、Rustdoc、Javadoc、GoDoc 以及 README 和 API 参考文档。
主要能力:分析代码中的函数/方法签名、参数、返回类型与值、可能抛出的异常、副作用与依赖、用法示例;据此生成对应语言的文档注释,并包含用途简述、参数与类型说明、返回值、异常、用法示例、边界情况与性能说明。对于项目级文档,可生成项目概述、安装说明、用法示例、API 参考、配置选项、贡献指南和许可证信息。README 模板结构包含项目名、简介、功能特性、安装命令、用法、API 参考、配置、贡献和许可证。文档规范中给出了 JavaScript/TypeScript 的 JSDoc 写法、Python 的 Google 风格 docstring 示例。
使用方式:以技能调用形式使用,示例命令为 @documentation-generator、@documentation-generator src/utils/、@documentation-generator --format jsdoc、@documentation-generator --readme-only、@documentation-generator UserService.js。参数可指定目标文件或目录、输出格式,或仅生成 README。
适用场景:为已有代码补充注释、为模块或类编写 API 文档、为项目生成 README 初稿。
限制:应匹配项目现有文档风格,只生成缺失文档、不覆盖自定义文档;示例应实用而非简单占位;需关注重要边界情况。资料未提供具体支持的语言版本、输出文件路径、与版本控制集成方式及收费信息。