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