Contents.m
файл предоставляет сводные данные программ в конкретной папке. help
документ
, и ver
функции относятся к Contents.m
файлы, чтобы отобразить информацию о папках.
Contents.m
файлы содержат только строки с комментариями. Первые две линии являются заголовками, которые описывают папку. Последующие линии перечисляют программные файлы в папке, наряду с их описаниями. Опционально, можно сгруппировать файлы и включать описания категории. Например, просмотрите функции, доступные в codetools
папка:
help codetools
Commands for creating and debugging code MATLAB Version 9.3 (R2017b) 24-Jul-2017 Editing and publishing edit - Edit or create a file grabcode - Copy MATLAB code from published HTML mlint - Check files for possible problems publish - Publish file containing cells to output file snapnow - Force snapshot of image for published document Directory tools 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
файл, help
и doc
команды отображают сгенерированный список всех программных файлов в папке.
Когда у вас есть набор существующих программных файлов в папке, самый легкий способ создать Contents.m
файл должен использовать Отчет о содержании. Основная цель Отчета о содержании должна проверять что существующий Contents.m
файл актуален. Однако это также проверяет ли Contents.m
существует и может сгенерировать новый файл на основе содержимого папки. Выполните эти шаги, чтобы создать файл:
В Браузере текущей папки перейдите к папке, которая содержит ваши программные файлы.
Щелкните, и затем выберите Reports> Contents Report.
В отчете, где запрошено, чтобы сделать Contents.m
файл, нажмите yes. Новый файл включает имена всех программных файлов в папке, с помощью линии описания (первая непустая строка с комментариями) каждый раз, когда это доступно.
Откройте сгенерированный файл в Редакторе и измените файл так, чтобы вторая строка с комментариями была в этой форме:
% Version xxx dd-mmm-yyyy
Не включайте пробелы в дату. Эта строка с комментариями включает ver
функция, чтобы обнаружить информацию о версии.
MATLAB® не включает live скрипты или функции при создании Отчета о содержании.
Проверьте ли ваш Contents.m
файл отражает текущее содержимое папки с помощью Отчета о содержании, можно следующим образом:
В Браузере текущей папки перейдите к папке, которая содержит Contents.m
файл.
Щелкните, и затем выберите Reports> Contents Report.
Вы не можете запустить отчеты, когда путем является UNC (Универсальное Соглашение о присвоении имен) путь; то есть, путь, который запускается с \\
. Вместо этого используйте фактический жесткий диск в своей системе или подключенный сетевой диск.
Отчет о содержании выполняет следующие проверки.
Проверяйте ли файл Contents.m... | Детали |
---|---|
\exists | Если нет никакого Contents.m файл в папке, можно создать один из отчета. |
Включает все программы в папке | Недостающие программы появляются в серых подсветках. Вы не должны добавлять программы, которые вы не хотите отсоединять конечным пользователям. |
Неправильно перечисляет несуществующие файлы | Перечисленные программы, которые не находятся в папке, появляются в розовых подсветках. |
Совпадает с описаниями программного файла | Отчет сравнивает описания файлов в Contents.m с первой непустой строкой с комментариями в соответствующем файле. Несоответствия появляются в розовых подсветках. Можно обновить или программный файл или Contents.m файл. |
Использует сопоставимый интервал между именами файлов и описаниями | Зафиксируйте выравнивание путем нажатия на fix spacing наверху отчета. |
Можно внести все предложенные изменения путем нажатия на fix all или открыть файл в Редакторе путем нажатия на edit Contents.m.