Main Content

创建实时函数

实时函数是在一个称为实时编辑器的交互式环境中同时包含代码和格式化文本的程序文件。与实时脚本类似,实时函数允许您通过将命令序列存储在程序文件中来重用它们。不过,实时函数提供更大的灵活性,主要体现在您可以向其传递输入值并获得输出值。

创建实时函数

要创建实时函数,请转至主页选项卡并选择新建 > 实时函数

将现有函数作为实时函数打开

如果您有现有函数,可以在实时编辑器中将其作为实时函数打开。以实时函数方式打开函数会创建一个文件副本,并保持原始文件不变。MATLAB® 会将原始脚本中的发布标记转换为新实时函数中的格式化内容。

要从编辑器将现有函数 (.m) 作为实时函数 (.mlx) 打开,请右键点击文档选项卡并从上下文菜单中选择以实时函数方式打开 functionName

您还可以转至编辑器选项卡,点击保存 ,然后选择另存为。然后,将保存类型: 设置为 MATLAB 实时代码文件 (*.mlx) 并点击保存

注意

您必须使用上述的转换方法之一将函数转换为实时函数。仅使用 .mlx 扩展名重命名该函数行不通,并可能损坏文件。

从选定代码创建实时函数

如果您有一个现有的大型实时脚本或函数,可以通过自动将选定代码区域转换为函数或局部函数,将它分成若干更小的部分。这称为代码重构

要重构选定的代码区域,请选择一行或多行代码,并在实时编辑器选项卡上的代码部分中,点击 重构。然后,从可用选项中进行选择。MATLAB 会用选定的代码创建一个函数,并将原始代码替换为对新创建函数的调用。

添加代码

创建实时函数后,向该函数添加代码并保存。例如,添加以下代码并将其另存为名为 mymean.mlx 的函数。mymean 函数计算输入列表的平均值并返回结果。

function a = mymean(v,n)    
    a = sum(v)/n;
end

添加帮助

要为该函数提供文字说明,请在函数定义上方添加格式化帮助文本。例如,添加标题和一些文字来描述功能。有关将帮助文本添加到函数的详细信息,请参阅为实时函数添加帮助

mymean live function with a title, descriptive text, and code

运行实时函数

您可以使用几种方法运行实时函数,包括从命令行窗口调用它们或从实时脚本调用。在 MATLAB Online™ 中,您还可以使用 运行按钮。

要从命令行窗口运行实时函数,请在命令行窗口中输入该函数的名称。例如,使用 mymean.mlx 来计算从 1 到 10 的 10 个连续数字的均值。

mymean(1:10, 10)
ans =
    5.5000

您也可以从实时脚本中调用实时函数。例如,创建名为 mystats.mlx 的实时脚本。添加以下代码来声明一个数组、确定该数组长度并将这两个值传递给函数 mymean

x = 1:10;
n = length(x);
avg = mymean(x,n);
disp(['Average = ', num2str(avg)])

运行该实时脚本。实时编辑器显示输出。

Live script with the output of mymean to the right of the disp statement used to display it

如果实时函数会显示文本或返回值,则实时编辑器会在调用函数的实时脚本中与实时函数调用并排显示输出。例如,在 mymean 中添加一行,以在返回值之前显示计算出的均值:

function a = mymean(v,n)
    a = sum(v)/n;
    disp(['a = ', num2str(a)])
end
运行 mystats 时,实时编辑器会将来自 mymean 的输出和来自 mystats 的输出显示在一起。

Live script with the output from mymean displayed to the right of the call to mymean, and again to the right of the disp statement used to display it

MATLAB Online 中,您可以使用 运行按钮以交互方式运行实时函数。当您使用 运行按钮运行实时函数时,输出会显示在命令行窗口中。要运行需要输入参量值或任何其他附加设置的实时函数,请通过点击运行 drop-down arrow 并添加一个或多个命令来配置 运行按钮。有关配置 运行按钮的详细信息,请参阅为函数配置运行按钮

将实时函数另存为纯代码

要将实时函数另存为纯代码文件 (.m),请执行下列操作:

  1. 实时编辑器选项卡上的文件部分中,选择保存 > 另存为...

  2. 在显示的对话框中,选择 MATLAB 代码文件 (UTF-8) (*.m) 作为保存类型

  3. 点击保存

保存时,MATLAB 会将所有格式化内容转换为发布标记。

相关主题