添加帮助文本

要创建帮助文本，请在文件的开头、函数定义行（带有 function 关键字的行）的上一行添加文本。

例如，创建一个名为 addme.mlx 的实时函数。

function c = addme(a,b)

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end

Add two values
C = ADDME(A) adds A to itself.
C = ADDME(A,B) adds A and B.

要添加“另请参阅”链接，请在帮助文本的末尾添加一个空白文本行，然后添加一个以 See also 字样开头的行，后跟函数名称列表。

See also SUM, PLUS

如果函数存在于搜索路径或当前文件夹中，help 命令会将其中的每个函数名称显示为指向其帮助文本的超链接。否则，help 将按帮助文本中函数名称的原样输出这些名称。为使链接正确显示，包含 See also 文本的行之前必须有一个空行。

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

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

查看帮助文本

在命令行窗口中键入 help addme。addme 函数的帮助文本出现在命令行窗口中，以函数名称开始，后跟第一行帮助文本（通常称为 H1 行）。然后，MATLAB^® 显示该函数的语法。最后，MATLAB 显示其余帮助文本。

键入 doc addme 可在单独的浏览器中查看格式化的帮助文本。

添加格式化文本和示例

为了增强使用 doc 命令时显示的文档，您可以格式化帮助文本并添加超链接、图像、方程和代码示例。要格式化帮助文本，请转至实时编辑器选项卡，并从文本部分的选项中进行选择。要插入超链接、图像、方程和代码示例，请转至插入选项卡，然后从可用选项中进行选择。

例如，在 addme 函数中，将一个方程添加到第二个语法描述中，并通过在“另请参阅“链接之前添加标题和两个 MATLAB 代码示例来创建示例节。

有关在实时编辑器中格式化文件的详细信息，请参阅在实时编辑器中设置文本格式。