为生活添加帮助功能
你可以为生活提供帮助你写的函数。帮助文本出现在命令窗口,当你使用帮助命令。你也可以使用医生命令来显示文本在一个单独的浏览器的帮助。
创建帮助文本插入文本在文件的开始,立即在函数定义线(线函数关键字)。
例如,创建一个函数addme.mlx这段代码:
函数c = addme (a, b)开关输入参数个数情况下2 c = a + b;情况下1 c = a +;否则c = 0;结束
当你输入帮助addme在命令窗口中,文本显示的帮助。
帮助文本的第一行,通常被称为H1,通常包含一个简短的描述函数。为一个函数,当显示帮助MATLAB®第一个显示的函数名称后面跟着H1。然后,MATLAB显示函数的语法。最后,用MATLAB显示剩余的帮助文本。
添加“参见”链接,添加一个文本行结束的时候帮助文本,从单词开始另请参阅其次是函数名的列表。如果该函数存在搜索路径或在当前文件夹,帮助命令显示每一个函数名作为超链接的帮助。否则,帮助打印函数名,因为他们出现在文本的帮助。
请注意
当多个程序具有相同的名称,帮助命令决定了哪些帮助文本来显示应用中描述的规则功能优先级顺序。然而,如果一个程序有内置函数,相同的名称帮助选择选择上下文菜单总是显示文档中内置函数。
加强进一步的文档显示在浏览器的帮助,可以格式化文本和添加超链接,图片,方程,示例代码。例如,在addme函数,选择和H1线住编辑器选项卡中,改变正常的文本样式标题。然后,将光标置于第二语法描述,去插入选项卡,并选择
方程。进入方程c = a + b并按Esc。最后,在插入选项卡上,选择代码示例>MATLAB并添加两个例子。关于在现场编辑格式文件的更多信息,见在现场编辑格式文本。
使用医生命令来显示文本在一个单独的浏览器的帮助。
你也可以添加帮助生活功能插入注释在文件的开始。注释在文件的开始使用时显示为帮助文本帮助和医生命令,类似于文本的文件显示。使用评论添加更多信息的帮助,明白了为程序添加帮助。
