Header Beispiel für MATLAB: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
(Die Seite wurde neu angelegt: „'''Autor:''' Prof. Ulrich Schneider Kategorie:MATLAB = Lektion 1: Matlab Getting Started = == Header == Verwenden Sie in…“) |
Keine Bearbeitungszusammenfassung |
||
| Zeile 41: | Zeile 41: | ||
%***************************************************************/ | %***************************************************************/ | ||
</pre> | </pre> | ||
== MATLAB® Hilfe == | |||
Jede Funktion sollte eine MATLAB® Hilfe bekommen, die erläutert, wie die Funktion aufzurufen ist. | |||
Die Hilfe wird vor den Header geschrieben und vom Header mit einer Freizeile getrennt. | |||
Sie läßt sich mit | |||
<pre> | |||
> help <Funktionsaufruf> | |||
</pre> | |||
anzeigen. | |||
Version vom 27. August 2021, 08:05 Uhr
Autor: Prof. Ulrich Schneider
Lektion 1: Matlab Getting Started
Header
Verwenden Sie in jeder Datei einen Header, der die nachfolgenden Fragen beantwortet:
- Um welches Modul handelt es sich?
- Was macht das Modul oder die Funktion?
- Wer sind die Autoren?
- Zu welcher Hochschule, Veranstaltung, Projekt gehört der Code?
- Bei Funktionen: Welche Eingangs- und Ausgangsparameter hat fie Funktion?
- Wann wurde die Datei erstellt und wann zuletzt geändert?
- Wird eine spezielle Toolbox verwendet?
Beispiel
%**************************************************************** % Hochschule Hamm-Lippstadt * %**************************************************************** % Modul : ML_5_2b * % * % Datum : 16-Mai-2014 * % * % Funktion : Moire Muster im Frequenzbereich entfernt * % * % Implementation : MATLAB R2013a * % * % Toolbox : Camera Calibration Toolbox * % * % Author : Prof. Schneider * % * % Bemerkung : basierend auf der * % Camera Calibration Toolbox for Matlab * % http://www.vision.caltech.edu/bouguetj/calib_doc/ * % * % Letzte Änderung : 03. Januar 2014 * % * %***************************************************************/
MATLAB® Hilfe
Jede Funktion sollte eine MATLAB® Hilfe bekommen, die erläutert, wie die Funktion aufzurufen ist. Die Hilfe wird vor den Header geschrieben und vom Header mit einer Freizeile getrennt.
Sie läßt sich mit
> help <Funktionsaufruf>
anzeigen.