Help Имя_Функции

Обеспечение помощи для вашей программы

Типы М-файлов

Как указывалось выше, имеется два типа М-файлов, общие свойства которых приведены в таблице

 

М-сценарии М-функции
  • Не допускают входных и выходных переменных
  • Допускают входные и выходные аргументы
  • Оперируют в данными из рабочей области
  • Внутренние переменные по умолчанию являются локальными по отношению к функциям
  • Предназначены для автоматизации последовательности шагов, которые нужно выполнять много раз
  • Предназначены для расширения возможностей языка MATLAB (библиотеки функций, пакеты прикладных программ)

Что такое М-файл ?

В данном разделе мы рассмотрим основные части, из которых состоит М-функция. Допус-тим, мы имеем следующую функцию fact,вычисляющую факториал целого числа:

 

function f = fact (n) %Строкаопределения функции

% FACT Factorial. %Первая строка помощи (H1 line)

% FACT(N) returns the factorial of N, H! %Текст помощи (Help text)

% usually denoted by N!

% Put simply, FACT(N) is PROD(1:N).

f = prod(1:n); %Тело функции

 

Эта функция имеет некоторые элементы, которые являются общими для всех функций систе-мы MATLAB:

•Строка определения функции. Эта строка задает имя функции , а также число и порядок входных и выходных аргументов.

•Строка H1 (H1 line). H1 обозначает «первую строку» помощи. MATLAB выводит эту стро-ку в командное окно, когда вы пользуетесь функцией lookfor или запрашиваете помощь по всей директории.

•Текст помощи (Help text). MATLAB выводит в командное окно данный текст вместе со строкой H1, когда вы запрашиваете помощь по конкретной функции, то есть вводите help Имя_Функции.

•Тело функции. Эта часть функции содержит коды (команды), которые выполняют вычисле-ния и определяют значения всех выходных переменных.

 

Вы можете снабдить пользователя информацией (помощью) о вашей программе, путем включения раздела текста помощи в начало М-файла. Этот раздел начинается со строки, сле-дующей непосредственно за строкой опеределения функции и заканчивается на первой пус-той строке, или строке тела функции. Каждая строка текста (эти строки окрашены в зеленый цвет) помощи должна начинаться символом процента (%). MATLAB выводит в командное окно данный текст каждый раз когда вы вводите

Вы можете также написать текст помощи для всей директории, путем создания файла со специальным именем Contents.m, который находится в вашей директории. Этот файл долже содержать только строки комментариев, то есть каждая строка должна начинаться со знака процента. MATLAB выводит на дисплей строки файла Contents.m всякий раз, когда вы вводите в командное окно строку