Kommentare
Wie bei einer Skriptsprache können Sie in ACLScript mit dem Schlüsselwort COMMENT Kommentare hinzufügen. Verwenden Sie Kommentare, damit Ihr Code verständlicher wird. Durch Kommentare können Sie mit Personen kommunizieren, die unter Umständen versuchen, Ihr Skript zu lesen, zu verwenden oder zu verstehen.
Kommentartypen
ACLScript unterstützt die folgenden beiden Kommentartypen:
- Einzeilige KommentareDer gesamte Text nach COMMENT wird ignoriert, bis das Ende der Zeile erreicht wird.
- Mehrzeilige KommentarblöckeBeginnen mit COMMENT. Jede folgende Zeile wird ignoriert, bis das Schlüsselwort END oder eine Leerzeile erreicht wird.
Einzeilige Kommentare
Verwenden Sie einzeilige Kommentare, um einzelne Schritte in Ihrem Skript oder um Variablen zu beschreiben:
COMMENT *** das Startdatum der Analyseperiode
v_Startdatum = `20150101`
Mehrzeilige Kommentarblöcke
Verwenden Sie mehrzeilige Kommentarblöcke, um Skripts oder Skriptabschnitte zu beschreiben.
COMMENT
**********************
Dieser Abschnitt des Skripts bereitet die Daten für den Import vor
**********************
END
Kopfzeilenkommentarblöcke
Es empfiehlt sich, am Anfang jedes Skripts einen Kopfzeilenkommentarblock einzufügen, der wichtige Skriptinformationen beinhaltet:
COMMENT
************************************************************
*** Skriptname: {App_ID}{Script name}
*** Parameter: {Detailed description}
*** Ausgabe: {Describe parameters}
*** Geschrieben von: {Name}, ABC Corporation, {Month YYYY}
*** Geändert von: {Name}, ABC Corporation, Skriptzweck und -logik
*** Version: 1.1.1 {app_ver.script_ver.defect.fix}
************************************************************
END