为MATLAB函数创建一个自定义模板,并提供格式良好的文档。
可选参数包括(对于每个参数,默认值可以在函数代码的顶部轻松修改):
-必要参数的个数
-可选参数#(即VARARGIN)[解析为'name',值对-详见下文]
-输出参数的个数
-功能的描述,包括在帮助文档的顶部
-截面分隔器的宽度
-自动生成的版权部分的作者姓名和作者电子邮件
-标志在文档中包含EXAMPLE部分
标志在文档中包含CREDITS部分
-创建m文件的输出目录
-表示创建后在默认编辑器中打开m文件
当指定了可选参数时,NEWFUNC将在代码开头自动创建一个单元格数组,用于定义可选参数的默认值,并将文件交换贡献SETARGS作为子函数添加到创建的m-file中。然后调用SETARGS来解析VARARGIN,以确定要覆盖哪些默认值。
最后,默认情况下,NEWFUNC总是会向创建的m文件添加一个名为MFILE_SHOWHELP的子函数。这是一个实用程序,当不带任何参数调用该函数时,它将m文件的帮助文档打印到命令窗口。
引用作为
鲍勃·斯普特(2022)。使用可定制的模板创建一个新的MATLAB函数GitHub (https://github.com/spunt/newfunc)。检索.
MATLAB版本兼容性
创建与R2015a
与任何版本兼容
平台的兼容性
窗户 macOS Linux标签
要查看或报告此GitHub插件中的问题,请访问GitHub库.
要查看或报告此GitHub插件中的问题,请访问GitHub库.