Чтобы определить, какой из ваших файлов программ имеет текст справки, можно использовать Отчет Справки.
В Отчете Справки вы задаете набор компонентов справки, которые вы хотите искать, такие как примеры или See Also линии. Для каждого искавшего файла, MATLAB® отображает текст справки для компонентов, которые он находит. В противном случае MATLAB отображает подсвеченное сообщение, чтобы указать, что компонент отсутствует.
Чтобы сгенерировать Отчет Справки, в Браузере текущей папки, перешли к папке, которую вы хотите проверять, кликнуть
, и затем выбрать Reports> Help Report. Отчет Справки отображается в веб-браузере MATLAB.
Примечание
Вы не можете запустить отчеты, когда путем является UNC (Универсальное Соглашение о присвоении имен) путь; то есть, путь, который запускается с \\. Вместо этого используйте фактический жесткий диск в своей системе или подключенный сетевой диск.
Эта таблица описывает доступные параметры для Отчетов Справки.
| Помогите сообщить об опции | Описание |
|---|---|
Покажите методы класса | Включайте методы в отчет. Если вы не выбираете эту опцию, то отчет включает в себя результаты для классов, но не для методов в файле определения класса. |
Покажите всю справку | Отобразите весь текст справки, найденный в каждом файле. Если вы также выбираете отдельные компоненты справки, такие как Описание, то помогаете тексту, появляется дважды в отчете для каждого файла: однажды для полного текста справки, и однажды для компонента. Если ваша программа имеет то же имя как другие программы на пути поиска файлов MATLAB, то |
Описание | Проверяйте на начальную, непустую строку с комментариями в файле. Эта линия иногда называется линией H1. |
Примеры | Проверяйте на примеры в тексте справки. Отчет Справки выполняет поиск без учета регистра горячей линии с вариантом однословным |
Смотрите также | Проверяйте на линию в справке, которая начинается со слов Если программы, перечисленные после |
\copyright | Проверяйте на строку с комментариями в файле, который начинается со слова Методические рекомендации должны включать область значений лет с года, вы создали файл к текущему году. |
