Scripting Kommentare

Aus SAP-Wiki
Wechseln zu: Navigation, Suche

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 schwer zu erinnern sein und meist werden auch andere Entwickler (zu einem späteren Zeitpunkt) mit diesem Coding umgehen müssen. Man hilft durch gute Kommentare somit sich und andere Entwicklern.

Man erkennt auskommentieres Coding durch die grüne Schriftfarbe.

Jede Zeile lässt sich in JavaScript und FormCalc mit den führenden Zeichen "//" beginnen und daher sollte im Zweifel auch dieses Kommentarzeichen benutzt werden, da man so nicht überlegen muss mit welcher Scriptsprache man gerade arbeitet.

Beispielkommentar

Scriptkommentare1.JPG

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.

Web-Links

Literatur