主要内容

为实时功能添加帮助

您可以为您编写的活动函数提供帮助。的帮助文本将出现在命令窗口中帮助命令。你也可以用the医生命令在单独的浏览器中显示帮助文本。

通过在文件的开头插入文本来创建帮助文本,就在函数定义行(带有函数关键字)。

例如,创建一个被调用的活动函数addme.mlx这段代码:

函数c = addme (a, b)开关输入参数个数情况下2 . c = a + b;情况下1 c = a + a;否则c = 0;结束
添加帮助文本来描述函数。

当你输入帮助addme在命令窗口中显示帮助文本。

帮助文本的第一行,通常称为H1行,通常包含对功能的简要描述。当显示一个函数的帮助时,MATLAB®first显示函数名,后面跟着H1行。然后,用MATLAB显示函数的语法。最后,MATLAB显示剩余的帮助文本。

要添加“另见”链接,请在以单词开头的帮助文本的末尾添加一行文本另请参阅后面是函数名列表。如果在搜索路径或当前文件夹中存在函数,则帮助命令将每个函数名显示为指向其帮助的超链接。否则,帮助输出在帮助文本中出现的函数名。

请注意

当多个程序具有相同的名称时,帮助命令通过应用中描述的规则确定要显示哪个帮助文本功能优先级顺序.但是,如果程序与内置函数具有相同的名称,则帮助选择选项在上下文菜单中总是显示内置函数的文档。

要进一步增强Help浏览器中显示的文档,可以对文本进行格式化,并添加超链接、图像、方程和示例代码。例如,在addme函数中,选择H1行并在住编辑器选项卡中,改变正常的文本样式标题.然后,将光标放在第二个语法描述的末尾,转到插入选项卡,并选择方程.进入方程C = a + b并按Esc.最后,在插入选项卡上,选择代码示例>MATLAB再加两个例子。有关实时编辑器中格式化文件的详细信息,请参见在实时编辑器中格式化文件

使用医生命令在单独的浏览器中显示帮助文本。

您还可以通过在文件开头插入注释来为活动函数添加帮助。属性时,文件开头的注释将显示为帮助文本帮助医生命令,类似于文件开头的文本显示方式。有关使用注释添加帮助的详细信息,请参见为您的程序添加帮助

相关的话题