主要内容

检查哪些程序有帮助

要确定哪些程序文件具有帮助文本,可以使用帮助报告。

在帮助报告中,您指定要搜索的一组帮助组件,例如示例或另请参阅行。对于每个文件搜索,MATLAB®显示它找到的组件的帮助文本。否则,MATLAB将显示一条高亮显示的消息,表明组件缺失。

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

请注意

当路径是UNC(通用命名约定)路径时,不能运行报告;也就是说,一条路径从\\.相反,在您的系统上使用一个实际的硬盘驱动器,或一个映射的网络驱动器。

该表描述了“帮助报告”的可用选项。

帮助报告选项 描述

显示类方法

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

显示所有帮助

显示在每个文件中找到的所有帮助文本。如果您还选择了单独的帮助组件,例如描述,然后帮助文本在每个文件的报告中出现两次:一次是整体帮助文本,一次是组件。

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

描述

检查文件中是否有初始的非空注释行。这条线有时被称为H1线。

例子

查看帮助文本中的例子。帮助报告对带有单个单词变体的帮助行执行不区分大小写的搜索例子.报告显示该行和随后的非空注释行,以及初始行号。

另请参阅

检查帮助中以单词开头的一行另请参阅.报告显示文本和初始行号。

如果程序列后另请参阅在搜索路径上,然后呢帮助命令生成指向这些程序的帮助的超链接。帮助报告指出,当一个程序在另请参阅线不在路径上。

版权

检查文件中以word开头的注释行版权.当有版权线时,报告还会检查年底是否当前。日期检查要求版权行包括单个年份(例如2012)或没有空格的年份范围(例如2001 - 2012).

推荐的做法是从创建文件的年份到当前的年份。

相关的话题