Добавьте справку для live функций
Можно обеспечить справку для live функций, которые вы пишете. Текст справки появляется в Командном окне, когда вы используете help команда. Также можно использовать doc команда, чтобы отобразить текст справки в отдельном браузере.
Создайте текст справки путем вставки текста в начале файла, сразу перед функциональной линией определения (линия с function ключевое слово).
Например, создайте live функцию под названием addme.mlx с этим кодом:
function c = addme(a,b) switch nargin case 2 c = a + b; case 1 c = a + a; otherwise c = 0; end
При вводе help addme в Командном окне, текстовых отображениях справки.
Первая линия текста справки, часто названного линией H1, обычно содержит краткое описание функции. При отображении справки для функции, MATLAB® первые отображения имя функции, сопровождаемое линией H1. Затем MATLAB отображает синтаксис функции. Наконец, MATLAB отображает любой остающийся текст справки.
Чтобы добавить "Видит также" ссылки, добавляет, текстовая строка в конце текста справки, который начинается со слов See also сопровождаемый списком имен функций. Если функции существуют на пути поиска файлов или в текущей папке, help команда отображает каждое из этих имен функций как гиперссылка на ее справку. В противном случае, help распечатывает имена функций, когда они появляются в тексте справки.
Примечание
Когда несколько программ имеют то же имя, help команда определяет, который текст справки отобразиться путем применения правил описал в Порядке приоритета функций. Однако, если программа имеет то же имя как встроенная функция, опция Help on Selection в контекстных меню всегда отображает документацию для встроенной функции.
Чтобы улучшить документацию, отображенную в Браузере документации далее, можно отформатировать текст и добавить гиперссылки, изображения, уравнения и пример кода. Например, в addme функция, выберите линию H1 и во вкладке Live Editor, измените стиль текста Normal в Title. Затем расположите свой курсор в конце второго описания синтаксиса, перейдите к вкладке Insert и выберите
Equation. Введите уравнение c = a + b и нажмите Esc. Наконец, во вкладке Insert, выберите Code Example> MATLAB и добавьте два примера. Для получения дополнительной информации о форматировании файлов в Live Editor, смотрите, Форматируют текст в Live Editor.
Используйте doc команда, чтобы отобразить текст справки в отдельном браузере.
Также можно добавить справку к live функциям путем вставки комментариев в начале файла. Комментарии в начале файла отображаются как текст справки, когда вы используете help и doc команды, подобные, к как текст в начале отображений файла. Для получения дополнительной информации о добавляющей справке с помощью комментариев, смотрите, Добавляет Справка для Программы.