Создание сводных файлов справки - Contents.m
Что такое файл Contents.m?
A Contents.m файл содержит сводные данные программ в определенной папке. The 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 файл вызывает помощь Не foldernameнайдена помощь для . Без 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 (Universal Naming Convention) путем; то есть путь, который начинается с \\. Вместо этого используйте фактический жесткий диск в системе или сопоставленный сетевой диск.
Этот Отчет о содержании выполняет следующие проверки.
| Проверьте, является ли файл Contents.m... | Подробнее |
|---|---|
| Существует | Если нет Contents.m файл в папке можно создать из отчета. |
| Включает все программы в папку | Отсутствующие программы появляются в серых подсветках. Вам не нужно добавлять программы, которые вы не хотите предоставлять конечным пользователям. |
| Неправильный список несуществующих файлов | Перечисленные программы, которые не находятся в папке, появляются в розовых подсветках. |
| Совпадает с описаниями программных файлов | Отчет сравнивает описание файла в Contents.m с первой непустой строкой с комментариями в соответствующем файле. Расхождения появляются в розовых подсветках. Можно обновить или программный файл, или Contents.m файл. |
| Использует последовательный интервал между именами файлов и описаниями | Исправить выравнивание можно нажав fix spacing в верхней части отчета. |
Можно внести все предложенные изменения нажав fix all, или открыть файл в редакторе нажав edit Contents.m.