主要内容

创建帮助摘要文件- content .m

什么是目录?m文件?

一个Contents.m文件提供特定文件夹中程序的摘要。的帮助，医生,版本功能参考Contents.m文件显示有关文件夹的信息。

Contents.m文件只包含注释行。前两行是描述文件夹的标题。随后的行列出了文件夹中的程序文件，以及它们的描述。可选地，您可以对文件进行分组并包括类别描述。方法中可用的函数codetools文件夹:

帮助codetools
创建和调试代码的命令MATLAB版本9.3 (R2017b) 2017年7月24日编辑和发布编辑-编辑或创建文件grabcode -从已发布的HTML mlint复制MATLAB代码-检查文件是否存在可能的问题publish -发布包含单元格的文件以输出文件snapnow -为已发布的文档强制映像快照目录工具mlintrpt -为文件或文件夹运行mlint，在浏览器中报告结果visdiff -比较两个文件(文本，MAT或二进制)或文件夹…

如果有的话不想让别人看到你的摘要程序文件，放一个空的Contents.m文件夹中的文件。一个空Contents.m文件的原因帮助foldername报告没有帮助foldername．没有一个Contents.m文件,帮助而且医生命令显示文件夹中所有程序文件的生成列表。

创建一个Contents。m文件

当文件夹中有一组现有程序文件时，最简单的方法是创建Contents.m文件是使用内容报告。内容报告的主要目的是检查现有的Contents.m文件是最新的。然而，它也检查是否Contents.m存在，并且可以根据文件夹的内容生成一个新文件。按照以下步骤创建一个文件:

  1. 在“当前文件夹”浏览器中，导航到包含程序文件的文件夹。

  2. 点击，然后选择报告>报告内容．

  3. 在报告中，凡提示作出Contents.m文件,点击是的．新文件包含文件夹中所有程序文件的名称，只要可用，就使用描述行(第一个非空注释行)。

  4. 在编辑器中打开生成的文件，并修改该文件，使第二个注释行如下所示:

    xxx版本号dd-mm -yyyy

    日期中不要包含任何空格。此注释行启用版本命令用于检测版本信息。

请注意

MATLAB®在创建内容报告时不包括活动脚本或函数。

检查现有内容。m文件

确认你的Contents.mfile使用contents Report反映文件夹的当前内容，如下所示:

  1. 属性所在的文件夹Contents.m文件。

  2. 点击，然后选择报告>报告内容．

请注意

当路径是UNC(通用命名约定)路径时，不能运行报表;也就是说，一条路径开始于\ \．相反，请使用系统上的实际硬盘驱动器，或映射的网络驱动器。

内容报告执行以下检查。

检查目录是否。m文件… 细节
存在 如果没有Contents.m文件，您可以从报表中创建一个。
包括文件夹中的所有程序 丢失的程序以灰色高亮显示。您不需要添加不想向最终用户公开的程序。
错误地列出不存在的文件 未在文件夹中列出的程序以粉红色高亮显示。
与程序文件描述相符 报告比较Contents中的文件描述。M对应文件中的第一个非空注释行。差异出现在粉色高光处。您可以更新程序文件或Contents.m文件。
在文件名和描述之间使用一致的空格 通过单击修复对齐固定间隔在报告的顶部。

您可以通过单击进行所有建议的更改解决所有，或在“编辑器”中单击打开该文件编辑Contents.m．

另请参阅

||