Документация

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

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

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

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

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

Описание

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

Примеры

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

См. также

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

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

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

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

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