本页对应的英文页面已更新,但尚未翻译。 若要查看最新内容,请点击此处访问英文页面。

为实时函数添加帮助

您可以为您编写的实时函数提供帮助文本。您使用 help 命令时帮助文本显示在命令行窗口中。您也可以使用 doc 命令在单独的浏览器中显示帮助文本。

要创建帮助文本,请在文件的开头、函数定义行(带有 function 关键字的行)的上一行插入文本。

例如,使用以下代码创建名为 addme.mlx 的实时函数:

function c = addme(a,b)

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end
添加帮助文本来描述该函数。

在命令行窗口中键入 help addme 时,将显示帮助文本。

第一行帮助文本(通常称为 H1 行)通常包含该函数的简要说明。显示函数帮助时,MATLAB® 首先显示函数名称,后跟 H1 行。然后,MATLAB 显示该函数的语法。最后,MATLAB 显示其余帮助文本。

要添加“另请参阅”链接,请在帮助文本的末尾添加一个文本行,该文本行以 See also 字样开头,后跟函数名称列表。如果函数存在于搜索路径或当前文件夹中,help 命令会将其中的每个函数名称显示为指向其帮助的超链接。否则,help 将按帮助文本中函数名称的原样输出这些名称。

注意

如果多个程序的名称相同,help 命令通过应用函数优先顺序中介绍的规则确定要显示的帮助文本。但是,如果程序的名称与某内置函数相同,上下文菜单中的关于所选内容的帮助选项始终都会显示有关该内置函数的文档。

要进一步增强“帮助”浏览器中显示的文档,您可以格式化文本并添加超链接、图像、方程和示例代码。例如,在 addme 函数中选择 H1 行,并在实时编辑器选项卡中将普通文本样式更改为标题。然后,将光标置于第二个语法描述的末尾,转至插入选项卡并选择 方程。输入方程 c = a + b 并按 Esc 键。最后,在插入选项卡中,选择代码示例 > MATLAB 并添加两个示例。有关在实时编辑器中格式化文件的详细信息,请参阅在实时编辑器中格式化文件

使用 doc 命令在单独的浏览器中显示帮助文本。

您还可以通过在文件开头插入注释来为实时函数添加帮助。当您使用 helpdoc 命令时,文件开头的注释显示为帮助文本,类似于文件开头文本的显示方式。有关使用注释添加帮助的详细信息,请参阅为程序添加帮助

相关主题