VorlageDokuSyntax

Allgemeines zu den Syntax-Erklärungen

Um die Syntax einer Programmiersprache zu erklären bedarf es einer Möglichkeit den Aufbau eines Befehls zu beschreiben. Hierbei muss man sowohl die Teile die so zu schreiben sind, also auch solche, die durch eigene Werte oder Variablen zu ersetzen sind, kennzeichnen und beschreiben. In dieser Dokumentation werden zum Erklären der Syntax der Metabefehle folgende Konventionen verwendet:

< >
Zwingend erforderlicher Parameter. Die Zeichen selbst werden nicht mit eingegeben.

$Bezeichner
Dies bedeutet, dass an der Stelle ein Variablenname für Bezeichner eingesetzt wird. #array $MeinArray z.B. bedeutet, dass als Bezeichner MeinArray benutzt wird. Hier sind also keine konstanten Zahlen z.B. erlaubt sondern lediglich Worte die den Anforderungen eines gültigen Vorlage Bezeichners genügen.

[] (eckige Klammern)
optionaler Parameter (Beispiel: #after n { Befehl1 [: Befehl2 ...] }) Das bedeutet, dass dieser Parameter angegeben werden kann, aber nicht muss. In dem Beispiel besagt die Schreibweise, dass für n ein Wert angegeben werden muss, und mindestens ein Befehl der dafür ausgeführt werden soll. Alle weiteren Befehle sind optional. Die eckigen Klammern werden nicht als solche selbst mit eingegeben! Ein gültiger Aufruf des obigen Beispiels: #after 10 { GIB auf ALLES : GEHE OST }. Mit BEFEHL ist ein vollständiger Eresseabefehl gemeint, der also durchaus aus mehreren "Worten" bestehen kann) Die Befehle untereinander werden durch einen : (Doppelpunkt) getrennt.

Des Weiteren gilt in der Dokumentation die Konvention, dass in Source-Beispielen alle Objekte und ihre Attribute klein, alle Eressea-Befehle groß geschrieben werden. Dies ist nicht so vorgeschrieben, es dient nur zur besseren Unterscheidung.