Main Content

检查哪些程序具有帮助

要确定您的哪些程序文件包含帮助文本,可以使用帮助报告。

在帮助报告中,指定一组要搜索的帮助组件,例如示例或See Also行。对于搜索的每个文件,MATLAB® 显示其查找的组件的帮助文本。否则,MATLAB 显示一则高亮消息以指示缺失该组件。

要生成帮助报告,请在当前文件夹浏览器中导航到要检查的文件夹,点击 ,然后选择报告 > 帮助报告。帮助报告显示在 MATLAB Web 浏览器中。

注意

您不能在路径为 UNC(通用命名约定)路径时运行报告;即路径以 \\ 开头。应使用您系统上的实际硬盘驱动器,或映射的网络驱动器。

下表描述了帮助报告的可用选项。

帮助报告选项说明

显示类方法

在报告中包括方法。如果您不选择此选项,则报告包括类的结果,而不是类定义文件中的方法的结果。

显示所有帮助

显示每个文件中找到是所有帮助文本。如果您还选择各个帮助组件(例如说明),则帮助文本在每个文件的报告中显示两次:一次针对总体帮助文本,一次针对相应组件。

如果您的程序与 MATLAB 搜索路径上的其他程序同名,则 help 命令生成这些重载项目的列表。MATLAB 会自动添加指向这些项目的帮助的链接。

说明

检查文件中的初始非空注释行。该行有时称为 H1 行。

示例

检查帮助文本中的示例。帮助报告对包含 example 的单个单词变体的帮助行执行不区分大小写的搜索。该报告显示该行和后续非空注释行,以及初始行号。

另请参阅

检查帮助中以单词 See also 开头的行。该报告显示文本和初始行号。

如果在 See also 之后列出的程序在搜索路径上,则 help 命令生成指向这些程序的帮助的超链接。帮助报告指示 See also 行中的程序何时不在该路径上。

版权

检查文件中以单词 Copyright 开头的注释行。当存在版权行时,该报告还检查终止年份是否为当前年份。日期检查需要版权行包括单个年份(例如 2012)或不含空格的一系列年份(例如 2001-2012)。

建议的做法是包括一系列年份,从您创建文件的年份开始一直到当前年份。

相关主题