Hinzufügen von Hilfetext für Ihr Programm

Dieses Beispiel veranschaulicht, wie Sie Hilfe für die von Ihnen geschriebenen Programme bereitstellen können. Hilfetext erscheint im Befehlsfenster, wenn Sie die Funktion help verwenden.

Erstellen Sie Hilfetext, indem Sie Kommentare am Anfang Ihres Programms einfügen. Wenn Ihr Programm eine Funktion umfasst, positionieren Sie den Hilfetext direkt unter der Zeile mit der Funktionsdefinition (die Zeile mit dem Schlüsselwort function). Wenn die Funktion einen arguments-Block umfasst, können Sie den Hilfetext zudem direkt unter dem arguments-Block einfügen.

Erstellen Sie beispielsweise eine Funktion in einer Datei namens addme.m, die Hilfetext umfasst: 

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

Wenn Sie help addme in der Befehlszeile eingeben, wird der Hilfetext im Befehlsfenster angezeigt:

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.

Die erste Hilfetextzeile, auch als H1-Zeile bezeichnet, umfasst üblicherweise den Namen des Programms und eine kurze Beschreibung. Der Dateien-Fensterbereich und die help- und lookfor-Funktionen verwenden die H1-Zeile, um Informationen über das Programm anzuzeigen.

Erstellen Sie See also-Links, indem Sie Funktionsnamen am Ende Ihres Hilfetexts in einer Zeile einfügen, die mit % See also beginnt. Wenn die Funktion im Suchpfad oder aktuellen Ordner existiert, zeigt der Befehl help jeden dieser Funktionsnamen als Hyperlink zur jeweiligen Hilfe an. Andernfalls druckt help die Funktionsnamen so, wie sie im Hilfetext erscheinen.

Sie können Hyperlinks (in Form von URLs) zu Webseiten in Ihren Hilfetext einfügen. Erstellen Sie Hyperlinks, indem Sie ein HTML <a></a>-Ankerelement einfügen. Verwenden Sie im Anker eine matlab:-Anweisung, um einen web-Befehl auszuführen. Beispiel:

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

Enden Sie Ihren Hilfetext mit einer leeren Zeile (ohne %). Das Hilfesystem ignoriert Kommentarzeilen, die nach dem Hilfetextblock erscheinen.

Hinweis

Wenn mehrere Programme denselben Namen aufweisen, ermittelt der Befehl help gemäß der Regeln unter Function Precedence Order, welcher Hilfetext angezeigt werden soll. Wenn ein Programm jedoch denselben Namen wie eine MathWorks® Funktion aufweist, zeigt die Option Help on Selection in Kontextmenüs stets die Dokumentation für die MathWorks Funktion an.

Siehe auch

|

Themen

Unterrichtsmaterialien