Format der Prozedur- und Funktions-Beschreibungen
Bei den Beschreibungen der Prozeduren und Funktionen werden folgende Konventionen verwendet:
Prozedur- und Funktionsnamen werden groß geschrieben. Dies ist im Quelltext nicht erforderlich.
Parameter werden immer mit einem Typ-Kennzeichen versehen, um den Typ deutlich zu kennzeichnen.
Wahlfreie Parameter werden in eckigen Klammern geschrieben. Das spezielle Verhalten beim Weglassen dieser Parameter wird entweder im Text beschrieben, oder es wird der Wert angenommen, der beim Parameter nach einem Gleichheitszeichen steht.
Groß geschriebene Parameter bezeichnen Variablen-Parameter.
Beispiel:
PSET x%, y% [, z%=1]
Hier kann der Parameter z als Wert des Pixels weggelassen werden, wobei dann der Wert 1 für "Setzen" angenommen wird.
|