SuperAPI AI 工具集

matlab-define-toolbox-api

编程与开发

查看项目

更新于 10-16 06:45

技能介绍

用途:把一个代码文件夹整理成 MATLAB 工具箱的接口规范。它扫描目录、清点文件、判断哪些属于工具箱、识别公开 API,最终产出 toolboxSpecification.m 这一“契约”文件。

主要能力:递归清点文件并按函数、类、脚本、实时脚本、测试、数据、配置、临时文件等分类;依据用户声明的用途把文件标为 Include、Support、Exclude 或 Uncertain;从 Include 集合中判断公开 API 与内部实现;生成 Markdown 范围与 API 报告供确认;最后按模板生成规范文件。

使用方式:提供 path(要分析的文件夹或文件列表)与 purpose(工具箱做什么、给谁用),缺失时会提示补全。流程为收集输入、清点目录、分类相关性、识别公开 API、展示报告并等待确认、生成规范。规范保存到项目根目录的 buildUtilities/toolboxSpecification.m,该目录通过 toolbox.ignore 或 package.ignore 排除在打包之外。spec.entries 是元胞数组,每项含 type 字段(function 或 classdef),字段约定见模板。

适用场景:用户想把一堆脚本、函数、测试、数据混合的代码打包成工具箱,或从零启动 files-to-package 流程。

限制:不用于向已有规范添加文件(应直接编辑 buildUtilities/toolboxSpecification.m)、不分析依赖(用 matlab-analyze-dependencies)、不构建 .mltbx(用 matlab-build-toolbox)、不生成文档(用 matlab-document-toolbox)。第 5 步必定暂停等待用户确认,确认前不写入任何内容;测试文件会被排除但记录在案,由 matlab-assess-toolbox 后续处理。具体收费、平台与效果资料暂未提供。