主要内容

帮助

命令窗口功能的帮助

描述

例子

帮助的名字显示指定功能的帮助文本的名字,例如函数、方法、类、工具箱或变量。

请注意

一些帮助文本用大写字母显示函数名,以使它们从文本的其余部分中脱颖而出。当输入这些函数名时,使用小写字母。对于以混合大小写出现的函数名(例如javaObject),键入如图所示的名称。

帮助显示与前面操作相关的内容。

例子

全部折叠

显示帮助MATLAB®删去函数。

帮助删去
删去删除文件或图形对象。删去File_name将指定的文件从磁盘中删除。可以使用通配符。例如,删去*.p从当前目录中删除所有p文件。。。

因为删去是一个函数和几个方法的名称,帮助文本包含指向同名方法列表的链接。

请求帮助删去的方法处理类。

帮助处理/删除

显示用户的帮助容器包,地图类,isKey方法

帮助容器帮助容器。地图帮助containers.Map.isKey

并不是所有的包、类和相关的方法或事件都需要完整的规范。例如,显示的帮助文本throwAsCaller的方法MException类。

帮助throwAsCaller

显示类型为变量的帮助日期时间

T = datetime帮助t

因为t的类型是日期时间,帮助命令显示的帮助文本日期时间类。

请求帮助一天,一种方法日期时间类。

帮助t.Day

列出文件夹中的所有函数草根/工具箱/ matlab / timefun通过指定部分路径。

帮助timefun

输入参数

全部折叠

功能名称,如函数、方法、类、工具箱或变量的名称,指定为字符向量或字符串标量。的名字也可以是操作符符号(例如+).

如果的名字是一个变量,帮助显示该变量的类的帮助文本。

要获取类的方法的帮助,请指定类名和方法名,并用句点分隔。例如,为了得到帮助methodname的方法类名称类别帮助classname.methodname

某些类和其他打包项要求您指定包名称。事件、属性和某些方法要求您指定类名。使用句点分隔名称的组件。例如,获取propertyname财产类名称类别classname.propertyname.来寻求帮助类名称类的包装名称包、类型packagename.methodname.来寻求帮助methodname的方法类名称类的包装名称包、类型packagename.classname.methodname

如果的名字出现在MATLAB搜索路径的多个文件夹中,帮助显示的第一个实例的帮助文本的名字在搜索路径上找到的。

如果的名字是超载,帮助显示指向具有相同名称的方法列表的链接。

如果的名字指定文件夹的名称或部分路径:

  • 如果文件夹包含非空Contents.m文件,帮助命令功能显示文件。Contents.m在文件夹中包含MATLAB程序文件的列表和它们的描述。

  • 如果文件夹中包含空Contents.m文件,帮助功能显示的名字这是一个文件夹

  • 如果文件夹中不包含Contents.m文件,帮助函数列出文件夹中每个程序文件的第一行帮助文本。

  • 如果的名字是MATLAB搜索路径上的文件夹和另一项(如方法、类、工具箱或变量)的名称帮助函数显示搜索路径上该项的关联文本和显示文件夹的帮助文本的链接。

提示

  • 要防止长描述在您有时间阅读之前从屏幕上滚下,请输入更多关于,然后输入帮助陈述

  • 要标识类的包名,请创建类的实例,然后调用类(obj)

替代功能

查看更广泛的帮助使用医生命令或功能浏览器

在R2006a之前引入