Exponenta 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® function, опция Help on Selection в контекстных меню всегда отображает документацию для функции MathWorks.

См. также

|

Похожие темы

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

Поддержка