Main Content

本页的翻译已过时。点击此处可查看最新英文版本。

help

命令行窗口中函数的帮助

说明

示例

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

注意

一些帮助文本用大写字符显示函数名称,以使它们与其他文本区分开来。键入这些函数名称时,请使用小写字符。对于大小写混合显示的函数名称(例如 javaObject),请按所示键入名称。

help 显示与先前操作相关的内容。

示例

全部折叠

显示 MATLAB® delete 函数的帮助。

help delete
delete Delete file or graphics object.
    delete file_name  deletes the named file from disk.  Wildcards
    may be used.  For example, delete *.p deletes all P-files from the
    current directory.
...

由于 delete 是一个函数和多个方法的名称,因此帮助文本包含指向具有相同名称的方法列表的链接。

请求有关 handle 类的 delete 方法的帮助。

help handle/delete

显示 containers 包、Map 类和 isKey 方法的帮助。

help containers
help containers.Map
help containers.Map.isKey

并非所有的程序包、类和相关方法或事件都需要完整的设定。例如,显示有关 MException 类的 throwAsCaller 方法的帮助文本。

help throwAsCaller

显示 datetime 类型的变量的帮助。

t = datetime
help t

因为 t 的类型为 datetimehelp 命令显示 datetime 类的帮助文本。

请求 Daydatetime 类的一个方法)的帮助。

help t.Day

通过指定部分路径列出文件夹 matlabroot/toolbox/matlab/timefun 中的所有函数。

help timefun

输入参数

全部折叠

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

如果 name 是变量,help 显示该变量的类的帮助文本。

要获取某个类的方法的帮助,请指定类名和方法名称(以句点分隔)。例如,要获取 classname 类的 methodname 方法的帮助,请键入 help classname.methodname

部分类和其他打包项目要求您指定包名称。事件、属性和一些方法要求您指定类名。以句点分隔名称的各个部分。例如,要获取 classname 类的 propertyname 属性的帮助,请键入 classname.propertyname。要获取 packagename 包中的 classname 类的帮助,请键入 packagename.methodname。要获取 packagename 包中 classname 类的 methodname 方法的帮助,请键入 packagename.classname.methodname

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

如果 name 已重载,help 将显示指向具有相同名称的方法列表的链接。

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

  • 如果文件夹包含非空的 Contents.m 文件,help 函数将显示该文件。Contents.m 包含文件夹中的 MATLAB 程序文件列表及它们的说明。

  • 如果文件夹包含空的 Contents.m 文件,help 函数将显示 name is a folder

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

  • 如果 name 既是文件夹的名称,也是 MATLAB 搜索路径中另一个项目(如方法、类、工具箱或变量)的名称,则 help 函数显示搜索路径中该项目的关联文本和指向显示该文件夹的帮助文本的链接。

提示

  • 在您有时间阅读较长说明之前为避免它们滚动出屏幕之外,请输入 more on,然后输入 help 语句。

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

替代功能

使用 doc 命令或函数浏览器查看更多详细帮助。

在 R2006a 之前推出