主要内容
为您的程序添加帮助
这个例子展示了如何为你编写的程序提供帮助。的帮助文本将出现在命令窗口中帮助函数。
通过在程序的开头插入注释来创建帮助文本。如果程序包含函数，请将帮助文本紧靠函数定义行(带函数关键字)。如果函数包含参数块，您还可以将帮助文本直接放置在参数块。
例如，在名为addme.m包括帮助文本:
函数c = addme (a, b)将两个值相加。% C = ADDME(A)将A添加到自身。％% C = ADDME(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创建超链接< > < / >锚元素。在锚内，使用amatlab:语句来执行网络命令。例如:
%了解更多信息，请参见. >
用空行结束你的帮助信息(不要用％）.帮助系统忽略出现在帮助文本块之后的任何注释行。
请注意
当多个程序具有相同的名称时，帮助命令通过应用中描述的规则确定要显示哪个帮助文本功能优先级顺序．但是，如果一个程序与MathWorks具有相同的名称®函数,帮助选择选项始终显示MathWorks函数的文档。
另请参阅
相关的话题
你也可以从以下列表中选择一个网站:
