Documentation

help

Help for functions in Command Window

Syntax

help
帮助名称

Description

helplists all primary help topics in the Command Window. Each main help topic corresponds to a folder name on the MATLAB®搜索路径。

helpnamedisplays the help text for the functionality specified byname,例如函数,方法,类,工具箱或变量。

Input Arguments

name

Operator symbol (such as+)或函数,类,方法,软件包,工具箱文件夹,变量或其他功能的名称,指定为字符向量。

Some classes and other packaged items require that you specify the package name. Events, properties, and some methods require that you specify the class name. Separate the components of the name with periods, such as:

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

Ifname是一个变量,helpdisplays the help text for the class of that variable.

帮助名称

To get help for the methods of thenameclass, specify

帮助名称.methodname

Ifnameis overloaded, that is, appears in multiple folders on the search path,helpdisplays the help text for the first instance ofnamefound on the search path, and displays a hyperlinked list of the overloaded functions and their folders.

Whennamespecifies the name or partial path of a toolbox folder:

  • If the folder contains a nonemptyContents.mfile, thehelpfunction displays the file.Contents.mcontains a list of MATLAB program files in the folder and their descriptions. IfContents.m存在,但是空的,Matlab回应不help found forname.

  • If the folder does not contain aContents.mfile, thehelpfunction lists the first line of help text for each program file in the folder.

  • Ifnameis the name of both a function and a toolbox,helpdisplays the associated text for both the toolbox and the function.

Examples

collapse all

显示帮助MATLABclosefunction.

helpclose

Becauseclose指函数的名称和几种方法的名称,帮助文本包括与超载方法的超链接。

请求数据库工具箱™的帮助close方法。

helpdatabase.close

显示帮助containerspackage,Mapclass, and theisKey方法。

helpcontainershelpcontainers.Maphelpcontainers.Map.isKey

不t all packages, classes, and associated methods or events require complete specification. For example, display the help for thethrowascallermethod of theMExceptionclass.

helpthrowascaller

显示变量的帮助t = datetime.

t = datetime helpt

Becausetis of typedatetimethehelpfunction displays help text for thedatetimeclass.

Request help forDay, a method of thedatetimeclass.

helpt.Day

列出文件夹中的所有功能Matlabroot/工具箱/MATLAB/常规by specifying a partial path.

help一般的

Tips

  • Some help text displays the names of functions in uppercase characters to make them stand out from the rest of the text. When typing these function names, use lowercase. For function names that appear in mixed case (such asJavaObject),键入如图所示的名称。

  • 要防止长时间的描述在有时间阅读之前滚出屏幕,请输入more on, and then enter thehelp陈述。

  • Some classes require that you specify the package name to display the help text. To identify the package name, create an instance of the class, and then callclass(obj).

Alternatives

View more extensive help using thedoccommand or the Function Browser. To open the Function Browser, click its icon,.

在R2006a之前引入

Was this topic helpful?