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

Покажите методы класса

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

Покажите всю справку

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

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

Описание

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

Примеры

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

Смотрите также

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

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

\copyright

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

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