Wprowadzenie do MatLab (31)

3.4. Polecenia złożone - M-pliki

Pliki programów w języku MATLAB (M-pliki) mogą występować w postaci funkcji lub w postaci skryptu MATLAB-a. Pliki funkcji mają następującą strukturę: Linia definicji M-pliku function f = fact(n)

Linia HI (help I)    % fact Factorial.

Tekst pomoc    % fact(N) returns the factorial of N,

usually denoted by N!.

Polecenia M-pliku f = prod(l:n); % Put simply, fact(n)

is prod(l:n).

Poszczególne elementy M-pliku mają określone funkcje:

-    Linia definicji M-pliku - linia ta występuje tylko w przypadku funkcji, określa nazwę funkcji oraz liczbę i kolejność wprowadzanych argumentów oraz otrzymywanych wyników: w przypadku skryptu linia ta nie występuje.

-    Linia HI (skrót od „help 1") - oznacza opcjonalną linię pomocy, rozpoczynającą się od znaku %. MATLAB wyświetla linię HI funkcji, gdy używamy komendy lookfor lub korzystamy z systemu pomocy. W linii HI podaje się skrót najważniejszych informacji na temat danego M-pliku.

-    Tekst pomocy w liniach, z których każda rozpoczyna się od znaku %. MATLAB wyświetla linię HI i tekst pomocy razem, gdy wywołujemy polecenie help z nazwą funkcji.

-    Polecenia M-pliku - zawierające ciąg poleceń wykonujących pewne czynności, które mogą być objaśniane na bieżąco komentarzem rozpoczynającym się znakiem % i kończącym się w danej linii.

Po wywołaniu komendy help nazwa_funkcji, MATLAB wyświetla wszystkie linie komentarza znajdujące się pomiędzy linią definicji funkcji a pierwszą z kolejnych linii, nie będącą linią komentarza (linia pusta lub zawierająca komendę). System pomocy ignoruje wszystkie linie komentarza występujące po bloku linii pomocy. Na przykład wpisanie komendy help sin daje efekt:

SIN Sine.

% SIN (X) is the sine of the elements of X.

Możliwe jest stworzenie tekstu pomocy dla całego katalogu. W tym celu tworzony jest plik o nazwie contents .m i umieszczany w danym katalogu. Ten plik może zawierać tylko linie komentarza, co oznacza, że każda jego linia musi zaczynać się znakiem procentu. MATLAB wyświetla tekst zawarty w pliku contents.m, za każdym razem, gdy wpiszemy komendę help nazwa_katalogu

Jeśli w katalogu mc ma pliku contents. m, użycie komendy help nazwa_katalogu spowoduje wyświetlenie pierwszej linii pomocy (linii HI) z każdego M-pliku znajdującego się w danym katalogu.

33