一个Contents.m
文件提供特定文件夹中程序的摘要。的帮助
,医生
和版本
功能是指Contents.m
文件以显示文件夹的信息。
Contents.m
文件只包含注释行。前两行是描述文件夹的标题。后续行列出文件夹中的程序文件及其说明。(可选)您可以对文件进行分组并包含类别描述。例如,查看中可用的函数编码工具
文件夹:
帮助编码工具
命令用于创建和调试代码MATLAB 9.3版本(R2017b) 24 - 7月2017编辑和出版编辑-编辑或者创建一个文件grabcode复制MATLAB代码发布HTML mlint -检查可能出现的问题发布文件包含细胞输出文件发布文件snapnow -力的快照图片发布的文档目录工具mlintrpt - Run mlint for file or folder, reporting results in browser visdiff - Compare two files (text, MAT, or binary) or folders ...
如果你做不想要别人看到你的程序文件摘要,请放置空的Contents.m
文件夹中的文件。一个空Contents.m
文件的原因帮助
报告foldername
没有得到帮助
.没有一个foldername
Contents.m
文件,帮助
和医生
命令显示文件夹中所有程序文件的生成列表。
当您在一个文件夹中有一组现有的程序文件时,最简单的方法是创建Contents.m
文件用于使用内容报告。内容报告的主要目的是检查现有的Contents.m
文件是最新的。然而,它也会检查是否Contents.m
存在,并可以根据文件夹的内容生成新文件。按照以下步骤创建文件:
在“当前文件夹”浏览器中,导航到包含程序文件的文件夹。
点击,然后选择报告>报告内容.
在报告中,哪里提示要做一个Contents.m
文件,点击是的.新文件包含文件夹中所有程序文件的名称,只要有描述行(第一个非空注释行)就使用它。
在编辑器中打开生成的文件,并修改文件,使第二个注释行以这种形式出现:
%版本xxx dd-mm -yyyy
在日期中不要有空格。该注释行启用版本
命令功能,检测版本信息。
请注意
MATLAB®创建内容报告时不包括实时脚本或函数。
验证您的Contents.m
文件通过目录报表反映当前目录的内容,如下所示:
在当前文件夹浏览器中,导航到包含文件夹的文件夹Contents.m
文件
点击,然后选择报告>报告内容.
内容报告执行以下检查。
检查目录是否。m文件… | 细节 |
---|---|
存在 | 如果没有Contents.m 文件,您可以从报告中创建一个。 |
包括文件夹中的所有程序 | 丢失的程序以灰色的高亮显示。您不需要添加不想公开给最终用户的程序。 |
错误地列出不存在的文件 | 未在文件夹中列出的程序以粉红色高亮显示。 |
匹配程序文件描述 | 该报告比较目录中的文件描述。M和相应文件中的第一个非空注释行。差异出现在粉红色的亮点。你可以更新程序文件或Contents.m 文件 |
在文件名和描述之间使用一致的空格 | 通过单击来修复对齐固定间隔在报告的最上面。 |
您可以通过单击进行所有建议的更改解决所有,或通过单击在编辑器中打开文件编辑Contents.m.