为程序添加帮助
这个例子展示了如何提供帮助你编写的程序。帮助文本出现在命令窗口,当你使用帮助函数。
创建帮助文本插入注释程序的开始。如果您的程序包含一个函数,函数定义下面的立即帮助文本位置线(线函数关键字)。如果函数包含一个参数块,你也可以位置下面的立即帮助文本参数块。
例如,创建一个函数在文件命名addme.m这包括帮助文本:
函数c = addme (a, b)% ADDME把两个值相加。% C = ADDME (A)添加一个。%% C = ADDME A和B (A, B)添加在一起。%%参见总和,加上。开关输入参数个数情况下2 c = a + b;情况下1 c = a +;否则c = 0;结束
当你输入帮助addme在命令行,帮助文本显示在命令窗口:
addme把两个值相加。C =addme(一)添加一个本身。C =addmeA和B (A, B)加在一起。另请参阅总和,+。
第一个帮助文本行,通常被称为H1,通常包括程序名称和简要描述。浏览器和当前文件夹帮助和lookfor函数使用H1行显示关于项目的信息。
创建另请参阅链接,包括函数名的末尾你的帮助文本开头的一行%见也。如果函数在搜索路径或存在于当前文件夹帮助命令显示每一个函数名作为超链接的帮助。否则,帮助打印函数名,因为他们出现在文本的帮助。
可以包含超链接的形式(url)网站在你的帮助文本。通过包含一个HTML创建超链接<一> < / >锚元素。在锚,使用matlab:语句执行一个网络命令。例如:
%的更多信息,请参见< a href = " matlab: %网络(“//www.tatmou.com”)”< / > > MathWorks网站。
结束你的帮助文本空白行(没有%)。帮助系统忽略了任何注释行出现在文本块的帮助。
请注意
当多个程序具有相同的名称,帮助命令决定了哪些帮助文本来显示应用中描述的规则功能优先级顺序。然而,如果一个程序作为MathWorks相同的名称®函数,帮助选择选择上下文菜单MathWorks总是显示文档的功能。
