Main Content

为程序添加帮助

此示例说明如何为您编写的程序提供帮助。您使用 help 函数时帮助文本显示在命令行窗口中。

通过在程序开始处插入注释来创建帮助文本。如果您的程序包含函数,请将帮助文本放在函数定义行(带有 function 关键字的行)的紧下方。如果该函数包含 arguments 代码块,您也可以将帮助文本放在 arguments 代码块的紧下方。

例如,在名称为 addme.m 并包含帮助文本的文件中创建函数:

function c = addme(a,b)
% ADDME  Add two values together.
%   C = ADDME(A) adds A to itself.
%
%   C = ADDME(A,B) adds A and B together.
%
%   See also SUM, PLUS.

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

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

addme  Add two values together.
    C = addme(A) adds A to itself.

    C = addme(A,B) adds A and B together.
 
    See also sum, plus.

第一个帮助文本行通常称为 H1 行,包括程序名称和简短说明。当前文件夹浏览器以及 helplookfor 函数使用 H1 行显示有关程序的信息。

通过在帮助文本结尾处以 % See also 开始的行中纳入函数名称,可创建 See also 链接。如果函数存在于搜索路径或当前文件夹中,help 命令会将其中的每个函数名称显示为指向其帮助的超链接。否则,help 将按帮助文本中函数名称的原样输出这些名称。

您可以在帮助文本中包含指向网站的超链接(以 URL 的形式)。通过包含 HTML <a></a> 锚点元素创建超链接。在锚点内,使用 matlab: 语句执行 web 命令。例如:

% For more information, see <a href="matlab: 
% web('https://www.mathworks.com')">the MathWorks Web site</a>.

以空白行(没有 %)结束您的帮助文本。帮助系统忽略出现在帮助文本块之后的任何注释行。

注意

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

另请参阅

|

相关主题