Main Content

doc

帮助浏览器中的参考页

全页折叠

语法

doc
doc name

说明

doc 打开帮助浏览器。如果帮助浏览器已打开但未显示，则 doc 将使其显示在前台并打开一个新的选项卡。

示例

doc name 为 name 指定的功能（例如函数、类或块）显示相关文档。

  • 如果 name 对应于 MathWorks® 参考页，则 doc 会在帮助浏览器中显示该页面。doc 命令不显示第三方或自定义的 HTML 文档。

  • 如果 name 不存在任何对应的参考页，则 doc 将在名为 name.m 或 name.mlx 的文件中搜索帮助文本。如果有可用的帮助文本，doc 将在帮助浏览器中显示该文本。

  • 如果 name 不存在任何对应的参考页并且没有关联的帮助文本，则 doc 将搜索 name 的文档，并在帮助浏览器中显示搜索结果。

示例

全部折叠

打开实时脚本

显示 abs 函数的参考页。 

doc abs

多个产品包含 abs 的不同版本。如果您的“帮助”预设支持显示这些产品的文档，则帮助浏览器将显示 MATLAB® abs 参考页以及一条包含其他 abs 版本链接的消息。该消息显示在页面顶端。

打开实时脚本

显示 handle 类的参考页。 

doc handle

显示 handle 类中的 findobj 方法的参考页。 

doc handle.findobj

显示 containers 程序包中的 Map 类的参考页。 

doc containers.Map
打开实时脚本

显示自定义类的格式化帮助文本。

类文件 sads.m 是一个示例文件，用于说明如何创建类。将示例文件夹添加到路径中，并请求 sads 的文档。 

addpath(...
   fullfile(matlabroot,'help','techdoc','matlab_env',...
   'examples'))
doc sads

显示有关 sads 类的 steer 方法的帮助。由于帮助文本遵循 MATLAB 约定，MATLAB 将在浏览器中格式化显示的帮助文本。 

doc sads.steer

输入参数

全部折叠

功能（如函数、类或模块）的名称，指定为字符向量。或者是运算符符号。

部分类和其他打包项目要求您指定包名称。事件、属性和一些方法要求您指定类名。用句号分隔名称的各个部分，如：

doc className.name
doc packageName.name
doc packageName.className.name

某些类的方法使用 doc 命令无法访问；请改用类参考页上的链接。

提示

  • 要访问第三方或自定义的文档，请打开帮助浏览器并导航至文档主页。然后，在页左侧的补充软件下，选择您要访问的文档。

版本历史记录

在 R2006a 之前推出

另请参阅

| | |

主题