MATLAB社区
MATLAB、社区和更多

工具箱是什么?新指南的作者

发布的Ned排水沟,2023年6月21日

(30天)| 401年视图0喜欢|0评论

的文件交换提供超过46000个免费的MATLAB项目。作者对于33854个项目,包括单词“工具箱”的称号。“工具箱”显然是一个有用的指示在MATLAB社区!但一个工具箱究竟是什么?这一直是有点模糊。最接近我们有一个普遍的定义是这样的:一个文件夹,其中包含一些相关的和潜在的有用的MATLAB文件。这个定义适用于从一个复杂的商业产品的温和的工具扔进一个文件夹。关于工具箱的凸点是有用的作为一个整体,也许只有你但也许别人。工具箱是一个可能会分发。

让我们试着阐明东西。考虑项目和工具箱。的区别是什么?

一个项目是你工作的全部。这些天,它经常住在GitHub库(因此“项目”和“回购”有时可以互换)。工具箱是一件你分发给那些将安装和使用它。所以工具箱来源于项目,但总的来说他们并不是一样的。一个简单的工作项目可能是相同的可分配的工具箱。但是当你添加测试和其他支持材料,不会附带工具箱,包含实体的项目金宝app变得更大的。

这里就是我有时图片:项目是车库,工具箱是汽车。

现在我把这张照片上的一些我们使用相关词汇。

这是最基本的工具箱是什么。但是让我们放大一点。应现代标准工具箱是什么样子的呢?

多年来,我们一直在处理他们的请求关于什么是一个好工具。人们想知道:我该如何组织我的工具箱代码?我如何避免常见的陷阱分布代码?我怎么能鼓励他人和我合作吗?

为了回答这些问题,我们最近推出了MATLAB工具箱最佳实践指导。你可以阅读所有的细节发表在这GitHub回购:

mathworks / toolboxdesign:创建MATLAB工具箱的最佳实践。

或者如果你愿意,你可以浏览这个简单的示例实例,一个标准的工具箱,算术工具。

mathworks /算术:工具箱创建实例展示MATLAB工具箱的最佳实践。

这里是一个简短的列表,我们推荐的东西。

使用GitHub
包括一个自述
使它成为一个MATLAB项目
把所有的“工作代码”成一个工具箱/子文件夹
与MLTBX文件包
创建活例子脚本(MLX文件)
创建测试可以运行使用GitHub的行动

我们不要求你要做所有这些事情是为了做个好人。这些是我们推荐的约定。如果你遵循这个建议(甚至只是一些),这将是更容易让别人去寻找并使用您的代码。您创建的工具将会有更多和更多的影响。

我会密切观察,这是一个早期版本的生活标准,所以你可以指望它随时间而变化。事实上,我们希望你能帮助我们发展开放问题或参与讨论。我们希望它会对你有用在MATLAB和分享工具。

|

评论

留下你的评论,请点击在这里MathWorks账户登录或创建一个新的。