Создание сводных файлов справки Contents.m
Что такое файл Contents.m?
Файл Contents.m предоставляет сводные данные программ в конкретной папке. help, doc и функции 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 заставляет help foldernameо No help found for foldernameContents.m help и команды doc отображают сгенерированный список всех программных файлов в папке.
Создание файла Contents.m
Когда у вас есть набор существующих программных файлов в папке, самый легкий способ создать файл Contents.m состоит в том, чтобы использовать Отчет о содержании. Основная цель Отчета о содержании должна проверять, что существующий файл Contents.m актуален. Однако это также проверяет, существует ли Contents.m и может сгенерировать новый файл на основе содержимого папки. Выполните эти шаги, чтобы создать файл:
В Браузере текущей папки перейдите к папке, которая содержит ваши программные файлы.
Щелкните
, и затем выберите Reports> Contents Report.В отчете, где запрошено, чтобы сделать файл
Contents.m, нажимают yes. Новый файл включает имена всех программных файлов в папке, с помощью строки описания (первая непустая строка с комментариями) каждый раз, когда это доступно.Откройте сгенерированный файл в Редакторе и измените файл так, чтобы вторая строка с комментариями была в этой форме:
% Version xxx dd-mmm-yyyy
Не включайте пробелы в дату. Эта строка с комментариями позволяет функции
verобнаружить информацию о версии.
Примечание
MATLAB® не включает live скрипты или функции при создании Отчета о содержании.
Проверка существующего файла Contents.m
Проверьте, отражает ли ваш файл Contents.m текущее содержимое папки с помощью Отчета о содержании, можно следующим образом:
В Браузере текущей папки перейдите к папке, которая содержит файл
Contents.m.Щелкните
, и затем выберите Reports> Contents Report.
Примечание
Вы не можете запустить отчеты, когда путем является UNC (Универсальное Соглашение о присвоении имен) путь; то есть, путь, который запускается с \\. Вместо этого используйте фактический жесткий диск в своей системе или подключенный сетевой диск.
Отчет о содержании выполняет следующие проверки.
| Проверяйте ли файл Contents.m... | Детали |
|---|---|
| \exists | Если нет никакого файла Contents.m в папке, можно создать один из отчета. |
| Включает все программы в папке | Недостающие программы появляются в серых подсветках. Вы не должны добавлять программы, которые вы не хотите представлять конечным пользователям. |
| Неправильно перечисляет несуществующие файлы | Перечисленные программы, которые не находятся в папке, появляются в розовых подсветках. |
| Совпадает с описаниями программного файла | Отчет сравнивает описания файлов в Contents.m с первой непустой строкой с комментариями в соответствующем файле. Несоответствия появляются в розовых подсветках. Можно обновить или программный файл или файл Contents.m. |
| Использует сопоставимый интервал между именами файлов и описаниями | Зафиксируйте выравнивание путем нажатия на fix spacing наверху отчета. |
Можно внести все предложенные изменения путем нажатия на fix all или открыть файл в Редакторе путем нажатия на edit Contents.m.