Exponenta Banner
exponenta event banner

Добавить справку для программы

В этом примере показано, как предоставить справку для написанных программ. Текст справки появляется в окне команд при использовании help функция.

Создание текста справки путем вставки комментариев в начале программы. Если программа включает функцию, поместите текст справки непосредственно под строкой определения функции (строка с function ключевое слово). Если функция содержит arguments блок, также можно расположить текст справки непосредственно под arguments блок.

Например, создайте функцию в файле с именем addme.m который включает в себя текст справки:

function c = addme(a,b)
% ADDME  Add two values together.
%   C = ADDME(A) adds A to itself.
%
%   C = ADDME(A,B) adds A and B together.
%
%   See also SUM, PLUS.

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end

При вводе help addme в командной строке в окне команд отображается текст справки:

addme  Add two values together.
    C = addme(A) adds A to itself.

    C = addme(A,B) adds A and B together.
 
    See also sum, plus.

Первая строка текста справки, часто называемая H1 строкой, обычно включает имя программы и краткое описание. Браузер «Текущая папка» и help и lookfor функции используют строку H1 для просмотра информации о программе.

Создать See also ссылки путем включения имен функций в конце текста справки в строке, которая начинается с % See also. Если функция существует в пути поиска или в текущей папке, help отображает каждое из этих имен функций как гиперссылку на справку. В противном случае help печатает имена функций, отображаемые в тексте справки.

В текст справки можно включить гиперссылки (в виде URL-адресов) на веб-сайты. Создание гиперссылок с помощью HTML <a></a> анкерный элемент. В пределах якоря используйте matlab: оператор для выполнения web команда. Например:

% For more information, see <a href="matlab: 
% web('https://www.mathworks.com')">the MathWorks Web site</a>.

Завершите текст справки пустой строкой (без %). Система справки игнорирует все строки комментариев, появляющиеся после блока текста справки.

Примечание

Если несколько программ имеют одинаковые имена, help определяет текст справки для отображения, применяя правила, описанные в разделе Порядок приоритета функции. Однако если программа имеет то же имя, что и функция MathWorks ®, опция Справка по выбору в контекстных меню всегда отображает документацию для функции MathWorks.

См. также

|

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

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

Поддержка