exponenta event banner

Создание файлов сводки справки - Contents.m

Что такое файл Contents.m?

A 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 foldername. Без Contents.m файл, help и doc отображает сгенерированный список всех программных файлов в папке.

Создание файла Contents.m

При наличии набора существующих программных файлов в папке проще всего создать Contents.m файл должен использовать отчет о содержимом. Основной целью отчета по содержимому является проверка наличия существующего Contents.m файл актуален. Однако он также проверяет, Contents.m существует и может создавать новый файл на основе содержимого папки. Чтобы создать файл, выполните следующие действия.

  1. В браузере текущей папки перейдите к папке, содержащей файлы программы.

  2. Щелкните, а затем выберите Отчеты > Отчет о содержимом.

  3. В отчете, где предлагается сделать Contents.m нажмите «Да». Новый файл включает имена всех программных файлов в папке, используя строку описания (первая непустая строка комментария), когда она доступна.

  4. Откройте созданный файл в редакторе и измените его таким образом, чтобы вторая строка комментария была в следующей форме:

         % Version xxx dd-mmm-yyyy

    Не включайте пробелы в дату. Эта строка комментария включает ver функция обнаружения информации о версии.

Примечание

MATLAB ® не включает живые сценарии или функции при создании Contents Report.

Проверка существующего файла Contents.m

Убедитесь, что ваш Contents.m файл отражает текущее содержимое папки, используя Отчет о содержимом, следующим образом:

  1. В браузере текущей папки перейдите к папке, содержащей Contents.m файл.

  2. Щелкните, а затем выберите Отчеты > Отчет о содержимом.

Примечание

Нельзя запускать отчеты, если путь является путем UNC (Universal Naming Convention); то есть путь, который начинается с \\. Вместо этого используйте фактический жесткий диск в системе или подключенный сетевой диск.

Отчет по содержимому выполняет следующие проверки.

Проверьте наличие файла Contents.m...Подробнее
СуществуетЕсли нет Contents.m в папке можно создать файл из отчета.
Включает все программы в папкуОтсутствующие программы отображаются серым цветом. Нет необходимости добавлять программы, которые не нужно предоставлять конечным пользователям.
Неверный список несуществующих файловПеречисленные программы, отсутствующие в папке, выделяются розовым цветом.
Соответствует описаниям программных файловОтчет сравнивает описания файлов в Contents.m с первой непустой строкой комментария в соответствующем файле. Расхождения появляются в розовых подсветках. Можно обновить файл программы или Contents.m файл.
Использование согласованного интервала между именами файлов и описаниямиИсправьте выравнивание, щелкнув фиксацию интервала в верхней части отчета.

Можно внести все предлагаемые изменения, щелкнув исправить все, или открыть файл в редакторе, щелкнув Изменить содержимое.

См. также

| |