检查哪些程序具有帮助
要确定您的哪些程序文件包含帮助文本,可以使用帮助报告。
在帮助报告中,指定一组要搜索的帮助组件,例如示例或See Also
行。对于搜索的每个文件,MATLAB® 显示其查找的组件的帮助文本。否则,MATLAB 显示一则高亮消息以指示缺失该组件。
要生成帮助报告,请在当前文件夹浏览器中导航到要检查的文件夹,点击 ,然后选择报告 > 帮助报告。帮助报告显示在 MATLAB Web 浏览器中。
注意
您不能在路径为 UNC(通用命名约定)路径时运行报告;即路径以 \\
开头。应使用您系统上的实际硬盘驱动器,或映射的网络驱动器。
下表描述了帮助报告的可用选项。
帮助报告选项 | 说明 |
---|---|
显示类方法 | 在报告中包括方法。如果您不选择此选项,则报告包括类的结果,而不是类定义文件中的方法的结果。 |
显示所有帮助 | 显示每个文件中找到是所有帮助文本。如果您还选择各个帮助组件(例如说明),则帮助文本在每个文件的报告中显示两次:一次针对总体帮助文本,一次针对相应组件。 如果您的程序与 MATLAB 搜索路径上的其他程序同名,则 |
说明 | 检查文件中的初始非空注释行。该行有时称为 H1 行。 |
示例 | 检查帮助文本中的示例。帮助报告对包含 |
另请参阅 | 检查帮助中以单词 如果在 |
版权 | 检查文件中以单词 建议的做法是包括一系列年份,从您创建文件的年份开始一直到当前年份。 |