exponenta event banner

Проверьте, какие программы имеют помощь

Чтобы определить, какие из файлов программ содержат текст справки, можно воспользоваться отчетом справки.

В отчете справки указывается набор компонентов справки, для которых требуется выполнить поиск, например, примеры или See Also строки. Для каждого найденного файла MATLAB ® отображает текст справки для найденных компонентов. В противном случае MATLAB отображает выделенное сообщение, указывающее на отсутствие компонента.

Чтобы создать справочный отчет, в браузере текущей папки перейдите к папке, которую требуется проверить, щелкните, а затем выберите Отчеты > Справочный отчет. Отчет справки отображается в веб-браузере MATLAB.

Примечание

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

В этой таблице описаны доступные параметры отчетов справки.

Параметр отчета справкиОписание

Показать методы класса

Включить методы в отчет. Если этот параметр не выбран, то отчет включает результаты для классов, но не для методов в файле определения класса.

Показать всю справку

Отображение всего текста справки, найденного в каждом файле. Если также выбрать отдельные компоненты справки, такие как Описание (Description), то текст справки появится дважды в отчете для каждого файла: один раз для общего текста справки и один раз для компонента.

Если программа имеет то же имя, что и другие программы на пути поиска MATLAB, то help создает список перегруженных элементов. MATLAB автоматически добавляет ссылки в справку для этих элементов.

Описание

Проверьте наличие начальной непустой строки комментария в файле. Эту линию иногда называют линией H1.

Примеры

Проверьте примеры в тексте справки. Справочный отчет выполняет поиск строки справки без учета регистра с однословным вариантом example. В отчете отображается эта строка и последующие непустые строки комментария, а также начальный номер строки.

См. также

Проверьте наличие строки в справке, которая начинается со слов See also. В отчете отображается текст и начальный номер строки.

Если программы перечислены после See also находятся на пути поиска, затем help создает гиперссылки на справку для этих программ. Справочный отчет показывает, когда программа в See also строка не находится на пути.

Авторское право

Проверьте строку комментария в файле, начинающуюся со слова Copyright. При наличии строки авторского права в отчете также проверяется, является ли год окончания текущим. Проверка даты требует, чтобы строка авторского права включала либо один год (например, 2012) или диапазон лет без пробелов (например, 2001-2012).

Рекомендуется использовать диапазон лет от года создания файла до текущего года.

Связанные темы