| www.Self-Tcl.de - Die deutsch-sprachige Tcl/Tk Gemeinschaft im Internet |
|
www.self-tcl.de
|
FORUM | StyleGuide | Manual | Source | Girokonto | |
| Herzlich
Willkommen bei Self-Tcl.de Die deutsch-sprachige Tcl Gemeinschaft Infos, Diskussionen, News, Forum & Mehr |
TCL StyleGuide (deutsch) |
|
|
| TCL Styleguide (deutsch) |
|
- Styleguide-Downloads
|
3.3. Der Prozedurkopf Nach dem Dateikopf folgen eine oder mehrere Prozeduren. Jede Prozedur beginnt mit einem Prozedurkopf, welcher die gesamte Prozedurdokumentation enthält, gefolgt von der Prozedurdeklaration und dem Prozedurrumpf. Abbildung 2 enthält ein Beispiel für einen Prozedurkopf. Der Prozedurkopf sollte alles enthalten, was ein Anwender dieser Prozedur zu deren Verwendung wissen muß, und nicht mehr. Er besteht aus drei Teilen: Der abstrakte Teil: Die ersten Zeilen des Prozedurkopfes enthalten den Namen der Prozedur, gefolgt von einer kurzen Beschreibung. Diese sollte keine detaillierte Schilderung der Implementierung, sondern eine allgemeine Zusammenfassung der Funktionalität darstellen. In manchen Fällen, wie z.B. bei rekursiven Prozeduren, wird empfohlen auch die Bedingungen zu beschreiben unter denen die Prozedur aufgerufen wird und woher der Aufruf erfolgt ist. Argumente: Dieser Teil des Prozedurkopfes beschreibt die Argumente, welche die Prozedur erwartet. Jedes Argument sollte mindestens eine Zeile umfassen. Der Kommentar sollte den erwarteten Typ und die Funktion des Argumentes beschreiben. Optionale Argumente sollten als solche hervorgehoben und der Vorgabewert bei nicht übergebenen Argumenten bezeichnet werden. Die Kommentare für jedes einzelne Argument sollten im gleichen Tabulatorabstand zum Argument stehen. Rückgabewert: Der letzte Teil des Prozedurkopfes beschreibt den Wert, der von der Prozedur zurückgegeben wird. Der Typ und die vorgesehene Verwendung des Rückgabewertes sollten beschrieben werden. Dieser Abschnitt sollte ferner etwaige Seiteneffekte erwähnen, die auftreten könnten. Die Datei tclProcHead.tcl enthält ein Muster für einen Prozedurkopf, welcher als Vorlage für neue Tcl Befehle verwendet werden sollte. Die Syntax von Abbildung 2 sollte genau eingehalten werden (selbe Einrückung, Doppelpunkt nach dem Prozedurnamen, u.s.w.).
|
| www.Self-Tcl.de | Impressum | Haftungsausschluss
|
zurück nach oben
- TOP -
(auf dieser Seite)