主要内容

创建和共享工具箱

您可以对 MATLAB® 文件进行打包,以创建可与其他人共享的工具箱。这些文件可以包含 MATLAB 代码、数据、App、示例和文档。当您创建工具箱时,MATLAB 会生成一个安装文件 (.mltbx),您或其他人可利用该文件来安装工具箱。

创建工具箱

从 R2025a 开始,工具箱打包与工程集成。要从您的文件创建工具箱,请在工程中创建一个工具箱任务。然后,使用该工具箱任务来配置和打包您的工具箱。

在 R2025a 之前的版本中: 要创建工具箱,请转至主页选项卡,然后在环境部分中,选择附加功能 > 打包为工具箱。然后,在“打包为工具箱”对话框中,点击 plus 按钮并选择您的工具箱文件夹。配置您的工具箱,然后点击打包以创建工具箱安装文件。

创建工具箱任务

创建工具箱的第一步是创建一个工具箱任务。然后,您可以使用该工具箱任务来配置和打包您的工具箱。

创建一个工具箱任务有两种方式:

  • 如果您的工具箱文件已包含在工程中,请打开该工程,转至工程选项卡,然后在工具部分中,点击 打包为工具箱。MATLAB 会创建一个与工程同名的工具箱任务,并在桌面的文档区域中打开它。

  • 如果您的文件尚未包含在工程中,请转至主页选项卡,然后在环境部分中,选择附加功能 > 打包为工具箱。点击浏览以选择包含您的工具箱文件的文件夹,然后点击确定。MATLAB 会创建一个包含您的文件的新工程和用于配置您的工具箱的工具箱任务。如果您选择的文件夹已包含一个工程,则改用现有工程。

要在关闭工具箱任务后重新打开它,请转至工程选项卡并点击 打包为工具箱。您也可以点击 编译器任务管理器来查看工程中的所有工具箱任务。

指定工具箱文件夹

工具箱文件夹部分显示工具箱文件夹和工具箱中文件的预览。要添加工具箱文件夹,请点击添加工具箱文件夹按钮。在添加工具箱文件夹后,要更改它,请点击更改工具箱文件夹按钮。

默认情况下,MATLAB 将源代码管理和工程资源文件排除在工具箱之外。此外,如果您的工具箱在同一个文件夹中包含同名的 P 代码文件和 MATLAB 代码文件 (.m),则 MATLAB 会从工具箱中排除 .m 文件。要在预览中显示排除的文件,请点击切换排除项的显示按钮。要将其他文件或文件夹从工具箱中排除,请点击编辑排除项按钮并将它们添加到打开的文本文件中。比较好的做法是排除与您的工具箱相关的任何源代码管理文件。

指定工具箱信息

工具箱信息部分中,指定有关工具箱的信息,如表中所述。

如果工具箱文件夹包含包定义文件,则在创建工具箱任务时,MATLAB 使用包信息(如描述、摘要和工具箱名称)来自动预填一些工具箱信息字段。然后,您可以进一步编辑这些字段。有关包的详细信息,请参阅Create and Manage Packages

工具箱信息字段描述
工具箱名称

输入工具箱名称(如有必要)。默认情况下,工具箱名称为工具箱文件夹的名称。

版本

按照 major.minor.bug.build 格式输入工具箱版本号。bugbuild 为可选项。

作者姓名、电子邮件和公司

输入工具箱作者的联系信息。

工具箱图像

指向该部分左上角的图像并点击浏览以选择表示工具箱的图像。该图像必须位于工程文件夹中。

摘要和说明

输入工具箱的摘要和说明。比较好的做法是编写简洁的摘要文本,并在说明文本中添加详细信息。

查看工具箱要求

MATLAB 会自动分析您的工具箱文件并检测要随工具箱包含的要求。工具箱要求部分显示这些要求。为确保您的工具箱包含所有必需文件,请按照表中所述查看检测到的要求并在必要时解除警告。

工具箱要求字段描述
必需的附加功能

指定工具箱所需的附加功能列表。在安装工具箱时,系统会下载并安装指定的附加功能。MATLAB 用它确定工具箱需要的附加功能自动填充此列表,默认将指定所有附加功能。您可以选择忽略不想与工具箱一起安装的附加功能。

如果 MATLAB 在列表中找不到附加功能的安装信息,您必须输入下载 URL。下载 URL 是 MATLAB 可以下载和安装附加功能的位置。安装工具箱时,MATLAB 使用指定的 URL 安装附加功能。

发现的要求

指定您的工具箱要求的、位于工具箱文件夹外的文件列表。MATLAB 用它确定工具箱需要的文件自动填充此列表,默认将指定所有文件。您可以选择忽略工具箱中不需要的任何文件。

点击查看分析按钮以在依赖关系分析器中查看分析。要重新运行分析,请点击重新分析按钮。

指定输出设置

输出设置部分显示您的工具箱安装文件 (.mltbx) 的文件名和路径。默认情况下,输出文件名是工具箱名称,文件路径是工程根文件夹中的 release 文件夹。

要更改工具箱安装文件的文件名和路径,请输入具有 .mltbx 扩展名的新文件名,并点击浏览以选择不同输出路径。

添加安装操作(可选)

安装操作部分显示在安装工具箱时发生的其他操作,包括设置 MATLAB 路径和 Java 类路径、安装 App 以及打开快速入门指南。您可以配置安装操作,如下表中所述。

安装操作字段描述
MATLAB 路径

指定用户在安装工具箱时添加到其 MATLAB 路径的文件夹的列表。默认情况下,该列表包含工程路径中的任何工具箱文件夹。您可以不将文件夹添加到用户的路径,只需在列表中清除它们即可。要管理工具箱安装的路径,请点击管理工程路径。要将列表重置为默认列表,请点击还原默认路径

Java 类路径

指定用户在安装工具箱时添加到其 Java® 类路径的 Java 文件的列表。安装工具箱时,JAR 文件会在 MATLAB 会话期间添加到动态路径中。当工具箱用户重新启动 MATLAB 时,JAR 文件将添加到静态路径中。

App

指定已发布的与工具箱关联的 MATLAB 可安装 App。

  • 要指定哪些 App(.mlapp 文件)将随工具箱安装并在用户的 MATLAB App 库中注册,请点击添加按钮并选择这些 App。或者,在“工程”面板中右键点击文件,点击添加标签,然后在工具箱任务菜单中选择 App 库文件标签。

  • 工具箱文件夹中的所有 .mlappinstall 文件都将安装并在用户的 MATLAB App 库中注册。

快速入门指南

为您的工具箱指定快速入门指南。为了工具箱任务能识别入门指南,请将该指南保存为实时脚本并命名为 GettingStarted.mlx,置于工具箱文件夹的 doc 子文件夹中。然后,在“工程”面板中,右键点击该文件,点击添加标签,然后在工具箱任务菜单中选择快速入门指南标签。您也可以通过点击添加按钮来生成和编辑 GettingStarted.mlx

工具箱的用户可以在“附加功能”面板中通过工具箱的“选项”菜单来查看快速入门指南。有关详细信息,请参阅获取和管理附加功能

配置工具箱可移植性

当用户安装工具箱时,MATLAB 使用工具箱可移植性部分中的信息。如果由于用户使用的平台或 MATLAB 版本不受支持而导致兼容性检查失败,MATLAB 会显示警告。但是,用户仍可以安装工具箱。

工具箱可移植性字段描述
支持的平台

指定支持工具箱的平台。考虑您的工具箱是否具有针对特定平台的第三方软件或硬件要求。MATLAB Online™ 不能与硬件交互,包括用于图像采集和仪器控制的设备。

版本兼容性

指定支持工具箱的 MATLAB 版本。

添加第三方软件(可选)

第三方软件部分列出用户在安装工具箱时安装在用户系统上的其他第三方软件 ZIP 文件。要添加随工具箱安装的其他第三方软件,请点击添加按钮并指定以下字段:

  • 软件名称 - 安装期间向用户显示的名称。

  • 平台 - 运行附加软件的平台。

  • 下载 URL - 包含其他软件的 ZIP 文件的 URL。要为不同平台指定不同下载 URL,请为每个平台添加单独的条目。

  • 许可证 URL - 在用户安装工具箱期间向他们显示的其他软件许可协议的 URL。在安装过程中,系统会提示用户阅读并接受许可协议。您必须为许可协议指定有效的 URL。

当用户安装工具箱时,MATLAB 会将所有附加第三方软件安装到 addons\Toolboxes\AdditionalSoftware 文件夹中,其中 addons 是默认附加功能安装文件夹。有关默认附加功能安装文件夹位置的详细信息,请参阅获取和管理附加功能

如果您的工具箱包含引用指定附加第三方软件的安装文件夹的代码,需确保这些引用可移植到其他计算机。请将引用替换为对生成的函数 toolboxname\getInstallationLocation.mlx 的调用,其中 toolboxname 是工具箱的名称。例如,如果要创建名为 mytoolbox 的工具箱,并且要引用名为 mysoftware 的附加软件的安装位置,请将以下代码

mysoftwarelocation = 'C:\InstalledSoftware\mysoftware\'
替换为以下代码:
mysoftwarelocation = mytoolbox.getInstallationLocation('mysoftware')

打包工具箱

在配置工具箱后,请按照以下步骤创建一个工具箱安装文件 (.mltbx):

  1. 点击工具箱任务顶部的重新分析按钮,以检查工具箱是否存在问题。在继续之前解决所有错误。

  2. 点击工具箱任务右上角的打包为工具箱按钮以创建您的工具箱安装文件 (.mltbx)。MATLAB 会在输出设置部分指定的文件夹中创建该文件。

共享工具箱

要与其他用户共享您的工具箱,请将工具箱安装文件 (.mltbx) 分发给他们。您在打包工具箱时添加的所有文件都包含在该文件中。当最终用户安装您的工具箱时,安装文件会管理其 MATLAB 路径和其他安装细节。

如需了解安装、卸载和查看工具箱信息的相关信息,请参阅获取和管理附加功能

您可以与其他人共享您的工具箱,方法是将工具箱安装文件添加到电子邮件消息的附件,或使用您通常用来共享文件的任何其他方法,例如上传到 MATLAB Central File Exchange。如果您将工具箱上传到 File Exchange,则您的用户可以从 MATLAB 中下载该工具箱。有关详细信息,请参阅获取和管理附加功能

注意

尽管工具箱安装文件可以包含您指定的任何文件,但 MATLAB Central File Exchange 对提交的文件设置了其他限制。数据和图像文件通常可以接受。但是,如果您的工具箱包含以下任何类型的文件,则无法将其提交到 File Exchange:

  • MEX 文件

  • 其他二进制可执行文件,例如 DLL 文件或 ActiveX® 控件

升级在以前版本中创建的工具箱

如果您有在 R2025a 之前的版本中创建的工具箱及其关联的 .prj 文件,MATLAB 可以自动将您的工具箱升级到工程工作流。

要升级您的工具箱,请在“文件”面板中双击 .prj 文件将其打开。MATLAB 会自动创建一个工程,并将您的工具箱文件和信息添加到一个新工具箱任务中。验证工具箱信息,然后使用打包工具箱中所述的工作流打包您的工具箱。

另请参阅

函数

主题