要确定哪些程序文件具有帮助文本,可以使用帮助报告。
在帮助报告中,您指定要搜索的一组帮助组件,例如示例或另请参阅
行。对于每个文件搜索,MATLAB®显示它找到的组件的帮助文本。否则,MATLAB将显示一条高亮显示的消息,表明组件缺失。
要生成帮助报告,请在“当前文件夹”浏览器中导航到要检查的文件夹,单击,然后选择报告>帮助报告.帮助报告显示在MATLAB web浏览器。
该表描述了“帮助报告”的可用选项。
帮助报告选项 | 描述 |
---|---|
显示类方法 |
在报告中包含方法。如果不选择此选项,则报告包括类的结果,但不包括类定义文件中的方法的结果。 |
显示所有帮助 |
显示在每个文件中找到的所有帮助文本。如果您还选择了单独的帮助组件,例如描述,然后帮助文本在每个文件的报告中出现两次:一次是整体帮助文本,一次是组件。 如果您的程序与MATLAB搜索路径上的其他程序同名,则 |
描述 |
检查文件中是否有初始的非空注释行。这条线有时被称为H1线。 |
例子 |
查看帮助文本中的例子。帮助报告对带有单个单词变体的帮助行执行不区分大小写的搜索 |
另请参阅 |
检查帮助中以单词开头的一行 如果程序列后 |
版权 |
检查文件中以word开头的注释行 推荐的做法是从创建文件的年份到当前的年份。 |