为程序添加帮助
这个例子展示了如何为您编写的程序提供帮助。方法时，“帮助”文本将出现在“命令窗口”中帮助函数。
通过在程序的开始插入注释来创建帮助文本。如果您的程序包含一个函数，请将帮助文本放在函数定义行(带有函数关键字)。
例如，在一个名为addme.m这包括帮助文本:
函数C = addme(a,b)将两个值相加。ADDME(A)将A添加到自身。％(A,B)把A和B相加。％参见SUM, PLUS。开关输入参数个数情况下2 c = a + b;情况下1 c = a + a;否则C = 0;结束
当你打字时帮助addme在命令行中，帮助文本显示在命令窗口中:
addme把两个值相加。C =addme(A)加上A。C =addme(A,B)把A和B相加。另请参阅总和，+．
第一个帮助文本行通常称为H1行，通常包括程序名称和简要描述。“当前文件夹”浏览器和帮助而且lookfor函数使用H1行显示有关程序的信息。
创建另请参阅链接，方法是在以。开头的帮助文本的末尾包含函数名%参见．如果函数存在于搜索路径或当前文件夹中，则帮助命令将每个函数名显示为指向其帮助的超链接。否则,帮助打印在帮助文本中出现的函数名。
您可以在帮助文本中包含到Web站点的超链接(以url的形式)。通过包含HTML创建超链接< > < / >锚元素。在锚中，使用matlab:语句来执行网络命令。例如:
更多信息，参见. >
用空行结束帮助文本(不带％)．帮助系统会忽略出现在帮助文本块之后的任何注释行。
请注意
当多个程序具有相同的名称时，则帮助命令中描述的规则确定要显示哪些帮助文本函数优先顺序．但是，如果程序的名称与MathWorks®函数,选择帮助选项总是显示MathWorks函数的文档。
另请参阅
相关的话题
这个话题有帮助吗?
您也可以从以下列表中选择网站:
