Header Vorlage

Aus aktuellem Anlaß hier ein paar Informationen zur Dokumentation der Banane-Routinen.

Die Informationen, die Ihr auf der Banane-Website zu jeder Routine sehen könnt, sind aus dem Sourcecode jeder Routine extrahiert worden. Damit dies möglich ist, enthält jede Banane-Routine vor dem eigentlichen Programmtext einen Kommentarbereich, den header, der diese Informationen enthält. Wenn Ihr selbst eine Routine zu Banane hinzufügen wollt, solltet Ihr ebenfalls einen header schreiben, damit andere Benutzer wissen, wie die Routine heißt und was sie tut, welche Parameter eingegeben werden müssen und was das Programm zurückliefert. Da der header automatisch übersetzt wird, ist seine Syntax recht streng festgelegt. Insbesondere muß er mit den Zeichen %+ beginnen und mit den Zeichen %- enden, und alle Überschriften müssen in Großbuchstaben und in einer festen Reihenfolge erscheinen. Falls die Syntax nicht eingehalten wird, schlägt die Übertragung der Informationen fehl und die Routine taucht nicht in der Online-Hilfe auf (ist aber durchaus Teil der Banane-Sammlung).

Damit Ihr es nicht ganz so schwer habt, gibt es eine eigene Routine in der Banane-Sammlung, die nichts tut, aber einen header besitzt, den Ihr per Copy&Paste als Vorlage für Eure eigenen header verwenden könnt. Diese Routine liegt hier:

/Banane/Documentation/example_function.m

Hier könnt Ihr den header online sehen, aber als Vorlage benutzt Ihr bitte den Anfang der MATLAB-Routine selbst, inklusive der Kommentarzeichen.