В этом примере показано, как обеспечить справку для программ, вы пишете. Текст справки появляется в Командном окне, когда вы используете 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®, опция Help on Selection в контекстных меню всегда отображает документацию для функции MathWorks.