为您的程序添加帮助- MATLAB和Simulink万博1manbetx - 万博1manbetx,s manbetx 845,万博尤文图斯

为程序添加帮助

这个例子展示了如何为您编写的程序提供帮助。方法时，“命令窗口”中会出现帮助文本帮助函数。

通过在程序开头插入注释来创建帮助文本。如果您的程序包含一个函数，请将帮助文本放在函数定义行的正下方(带有函数关键字)。如果函数包含参数块时，还可以将帮助文本放置在参数块。

例如，在一个名为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来创建超链接< > < / >锚元素。在锚定中，使用matlab:语句执行网络命令。例如:

更多信息请参见 MathWorks网站. >

用空行结束帮助文本(不带％)．帮助系统将忽略出现在帮助文本块之后的任何注释行。

请注意

当多个程序具有相同的名称时，帮助命令通过应用中描述的规则确定要显示哪些帮助文本函数优先顺序．但是，如果一个程序具有与MathWorks相同的名称^®函数,选择帮助上下文菜单中的选项总是显示MathWorks函数的文档。