用途:为 MATLAB 工具箱生成完整文档产物,包括 README.md、functionSignatures.json、GettingStarted.m、示例脚本与 demos.xml,遵循 mathworks/toolboxdesign 约定。适用于项目结构已建立后补充文档、生成示例或函数签名、编写入门指南,或在工具箱就绪评估前满足文档检查项。
主要能力:扫描项目结构,识别 toolbox/ 或扁平布局;分析 .m 文件,提取函数名、签名、H1 行、输入输出参数与 arguments 块,区分 public、private、internal、namespaced 函数;按 Contents.m 或目录结构归类;生成 README、函数签名 JSON、入门脚本、示例与 demos.xml,并可将文件加入 MATLAB 项目。
使用方式:提供项目根目录绝对路径,可选指定生成范围(all、readme、signatures、gettingstarted、examples)与工具箱文件夹。流程为发现结构、分析函数、展示计划并等待确认、逐项生成、加入项目、报告结果。functionSignatures.json 需含 "_schemaVersion": "1.0.0",可用 validateFunctionSignaturesJSON 校验。
限制:不编写或修复 MATLAB 代码,不负责构建打包与就绪评估,不生成测试。绝不覆盖已有文件,不移动或重命名文件,生成前需用户确认。仅记录真实存在的函数,不虚构函数名、签名或描述;准确性优先于完整性,无法确认类型时省略而非猜测。GettingStarted.m 须无交互运行、计算快速,示例须可执行。README 位于项目根目录不随 .mltbx 发布,GettingStarted.m 位于 toolbox/doc/,示例位于 toolbox/examples/。若已存在 GettingStarted.mlx 则跳过。具体模板与规则细节暂未提供。