Self-Tcl FORUM - Das deutsche Tcl Tk Forum
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)   
Die deutsche Übersetzung des TCL Styleguide
  
   TCL Styleguide (deutsch)
  


- Styleguide-Downloads
















 

 

3.1. Der Dateikopf

Der erste Teil einer Quelltextdatei wird Dateikopf genannt. Er enthält Informationen, die für die gesamte Datei relevant sind. Diese umfassen alles außer den Definitionen der Prozeduren in der Datei.

Der Dateikopf besteht typischerweise aus vier Teilen, wie in Abbildung 1 gezeigt wird:

(1) Abstract / Allgemein: (Zusammenfassung)
Die ersten Zeilen enthalten den Dateinamen und eine kurze Beschreibung der in der Datei enthaltenen Funktionen.

(2) Copyright Vermerk:
Der Vermerk schützt das Urheberrecht an der Datei. Das in Abbildung 1 aufgeführte Copyright ist in dem Quelltext von Tcl und Tk enthalten. Produktspezifischere Packages würden wahrscheinlich zusätzlich die Worte "Alle Rechte vorbehalten." enthalten. Wenn mehrere Programmierteams Teile eines Quelltextes beigetragen haben, dann sollte jedes Team eine eigene, unterscheidbare Copyrightzeile haben.

(3) Revisionstext:
Dieser Text wird vom Quelltextkontrollsystem automatisch verwaltet (RCS oder SCCS). Es bestimmt die aktuelle Version der Datei, das Datum der letzten Bearbeitung, usw.

(4) Package Definition:
Jede "require" Anweisung für andere Packages, auf denen das aktuelle Package aufbaut, sollte am Anfang der Datei stehen. Alle globalen Variablen, auf die innerhalb der Datei zugegriffen werden, sollten ebenfalls am Dateianfang deklariert werden. Danach sollten die Namespace Definition und dort als Erstes die Exportliste aufgeführt werden.

Der Dateikopf sollte möglichst genau der oben beschriebenen Reihenfolge und der in Abbildung 1 gezeigten Syntax entsprechen. Die Datei filehead.tcl enthält ein Muster für einen Dateikopf.

Abbildung 1

Die Quelltextdatei Packages













| www.Self-Tcl.de | Impressum | Haftungsausschluss |




zurück nach oben
- TOP -
(auf dieser Seite)