MATLAB 中如何使用 help

MATLAB 中的 help

语法

help
help name

描述

help 会在命令行列出所有的主要 help 主题。每一个主题对应 MATLAB 搜索路径中一个文件夹名称。

help name 显示 指定 name 对应的功能文本，name 可以是函数，方法，类，工具箱或者变量。

输入参数

name

可以是操作符，函数名，类，方法，包，工具箱文件夹，变量或其它的功能名称。

某些类和其它包需要你指定包名。事件，属性和某些方法要求你指定类名。使用点分隔名称的组件，即：

help className.name
help packageName.name
help packageName.className.name

如果 name 是变量，help 显示变量所属类的帮助文本。

help name

要使用 name 类的方法的 help，则为：

help name.methodname

如果名称重载（出现在搜索路径上的多个文件夹中），help 将显示搜索路径上找到的第一个名称实例的帮助文本，并显示重载函数及其文件夹的超链接列表。

当 name 指定工具箱文件夹的名称或部分路径时：

如果文件夹包含非空的 Contents.m 文件，则 help 将显示该文件。 Contents.m 包含文件夹中的 MATLAB 程序文件列表及其说明。如果 Contents.m 存在，但是为空，则M ATLAB 显示 No help found for name。

如果该文件夹不包含 Contents.m 文件，则 help 会列出该文件夹中每个程序文件的第一行帮助文本。

如果 name 是函数和工具箱的名称，则 help 会显示工具箱和函数的关联文本。

 

示例：

函数或者重载方法

显示 MATLAB close 函数的 help

help close

因为 close 指向函数和几个方法，所以帮助文本包含指向重载方法的超链接。

使用 Database 工具箱的 close 方法的 help：

help database.close

包，类，方法

显示 containers 包，Map 类，isKey方法的 help：

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

也并不是所有的包，类，方法和事件都需要完整的指定。如类 MEception 中的 throwAsCaller 方法：

help throwAsCaller

变量

显示变量 t = datatime 的 help

t = datetime
help t

因为 t 是 datetime 类型的，所以 help函数会显示 datetime 类的帮助文本。

同理，如果要显示变量方法的 help，则为（Day 是 datetime 类的方法）

help t.Day

文件夹中的函数

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

help general

注意

某些帮助文本以大写字符显示函数的名称，以使它们与其它部分做出区分。 键入这些函数名称时，应使用小写。 对于以混合大小写形式出现的函数名称，应键入显示名称。

要防止长描述阅读时过于耗时，应输入更多信息，然后输入帮助声明。

某些类要求指定包名称以显示帮助文本。 要标识包名称，应创建该类的实例，然后调用class（obj）。

Python 中的 help

包

py.help('textwrap')

类 

py.help('textwrap.TextWrapper')

 类方法

py.help('textwrap.TextWrapper.wrap')

函数

py.help('textwrap.fill')

参考资料：

1.MATLAB 官方文档:https://ww2.mathworks.cn/help/