Scripting Kommentare
Siehe JavaScript und FormCalc Scripting im LiveCycle Designer.
Jedes Scripting sollte mindestens einen kurzen führenden Kommentar haben. Im Zweifel lieber mehr kommentieren als zu wenig.
Was einem beim Programmieren klar ist, wird Wochen oder Monate später nur noch oberflächlich im Gedächtnis sein und fast immer werden auch andere Entwickler (früher oder später) mit diesem Coding umgehen müssen. Mit guten Kommentaren hilft man sich und jedem anderen Entwickler, der mit dem Formular und dem darin enthaltenen Scripting arbeiten muss.
Man erkennt auskommentieres Coding durch die grüne Schriftfarbe.
Mit "//" lassen sich in JavaScript und FormCalc alle nachfolgende Zeichen der gleichen Zeile auskommentieren. Daher sollte im Zweifel dieses Kommentarzeichen benutzt werden, da man so nicht überlegen muss mit welcher Scriptsprache man gerade arbeitet.
Beispielkommentar
Kommentare in JavaScript
In JavaScript werden einzeilige Kommentare mit einem "//" eingeleitet. Dieser Befehl "//" muß auch nicht am Anfang einer Zeile stehen, sondern kann in einer Zeile einer Anweisung folgen.
// Hier folgt ein einzeiliger Kommentar
Mehrzeilige Kommentare werden in JavaScript mit einem "/*" vor der ersten Kommentarzeile begonnen und am Ende der letzten Kommentarzeile mit "*/" abgeschlossen.
Wird "/*" nicht durch "*/" abgeschlossen, wird ab dem "/*" der Rest des Codings auskommentiert, was oft auch eine schnelle und gewünschte Lösung ist.
/* Hier kommt ein mehrzeiliger Kommentar, da zum Coding sehr viel zu sagen ist. */
Kommentare in FormCalc
In FormCalc werden Kommentare einzeilig durch das Zeichen "//" oder durch ";" eingeleitet. Ein Kommentarzeichen, wo eine Reihe von Zeilen als Kommentar gekennzeichnet werden, gibt es (wie auch bei ABAP) nicht.
// dies ist ein Kommentar
oder
; dies ist ein Kommentar
„Scr“-Kennzeichnung von Objektknoten
- Es hat sich bewährt in der Objekthierarchie die Objektknoten mit Scripting mit dem Präfix „Scr“ oder „scr“ zu kennzeichnen. Man findet so Objekte mit Scripting leichter.
- Man will z. B. das Coding in diesem Knoten überarbeiten, weil es das Scripting nicht wie gewünscht funktioniert oder man möchte aus dem Code lernen und Teile/das Ganze kopieren, um es anderer Stelle wiederverwenden zu können. In jedem Fall hilft es bei der Scriptingsuche und stört ansonsten auch nicht.
- Man muss nur bei der Umbenennung vorsichtig sein, wenn ein anderes Scripting auf diesen Objektknoten referenziert oder in einem SOM-Ausdruck ein Bestandteil ist. Daher ist es vorteilhaft, wenn man sofort bei der Scripterstellung auch gleich den Objektknoten umbenennt. Ggf. müsste dann die Referenz auf den geänderten Knotennamen angepasst werden.
