Kommentare in Formeln | Tipps Tuesdays #018

[RolandSchubert]

Für mich ist einer der großen Vorteile von Alteryx, dass man als Anwender einfach und intuitiv verstehen kann, was in einem Workflow passiert. Und das gilt in der Regel auch für Ausdrücke im Formula Tool (das gilt natürlich auch für Multi-Row / Multi-Field Formula Tool oder Filter Tool).

Hier etwa ist doch unmittelbar klar, was da passiert, oder? 

Es kann natürlich auch etwas komplexer werden - aber auch dann ist meistens nachvollziehbar, was passiert. Meistens. Manchmal gibt es eben doch Fälle, in denen man sich fragt, was genau da jetzt passieren soll. Und vor allem: warum? Denn wenn man einen Workflow anschaut, den ein anderer Anwender entwickelt hat, geht es ja vielfach auch darum, den Gedankengang nachzuvollziehen - da hilft es dann schon, wenn ein Schritt vielleicht erklärt wird. Ich erlebe das manchmal schon, wenn ich einen Workflow bearbeiten muss, den ich selbst vor längerer Zeit gebaut habe - da frage ich mich oft, was ich mir dabei damals so gedacht habe ...

Also - wie kann man es hier anderen (und sich selbst) leichter machen? Wir könnten natürlich mit Annotations oder Comments arbeiten, aber ein Kommentar im Ausdruck selbst ist sicherlich der bessere, übersichtlichere Weg.

Oft reicht ja ein kurzer Hinweis, warum eine bestimmte Funktion verwendet wird. In diesem Fall leiten wir einfach die Kommentarzeile mit "//" ein:

Die komplette Zeile wird dann als Kommentar interpretiert und in grüner Schrift angezeigt. 

Alternativ können wir die Zeile auch mit "/*" einleiten und mit "*/" beenden:

Wichtig: Es ist notwendig, den Kommentar auch zu beenden, sonst wird die Zeile nicht als Kommentar erkannt:

Allerdings kann bei dieser Variante der Kommentar auch über mehrere Zeilen gehen:

"/*" signalisiert den Beginn des Kommentars, "*/" zeigt das Ende an, ganz gleich, wie viele Zeilen der Kommentar umfasst. Es könnten sogar Leerzeilen verwendet werden, um einen besonders umfangreichen Kommentartext noch zu untergliedern.

Verwenden wir "//" als Kommentarzeichen, so müssen wir bei mehrzeiligen Kommentaren jede einzelne dieser Zeilen mit "//" einleiten:

 

Es muss natürlich nicht unbedingt eine vollständige Kommentarzeile sein, der Kommentar kann auch einfach hinter den jeweiligen Ausdruck geschrieben werden; bei der "//"-Variante sieht das dann so aus:

Das funktioniert mit der "/*"-"*/" - Form genauso. 

Ob der Kommentar nun in einer eigenen Zeile über (oder unter) dem jeweiligen Ausdruck steht oder einfach angehängt wird, ist sicherlich eine Frage des persönlichen Geschmacks. Ich persönlich finde eine eigene Zeile normalerweise übersichtlicher - die zusätzliche Zeile hat ja keine echten Nachteile. Auch die Form der Kommentierung, also ob "//" oder "/*"-"*/" verwendet wird, ist eine individuelle Entscheidung - allerdings würde ich dringend empfehlen, sich für eine Form zu entscheiden und Eineitlichkeit zu wahren.

Wichtig ist nur, dass die Möglichkeit, Kommentare zu verwenden, genutzt wird - es wird sich auf jeden Fall auszahlen. 

Weitere Tipps Tuesday Beiträge

Dieser Eintrag ist Teil der Tipps Tuesday-Serie, alle Einträge dieser Serie findest du in unserem Index aufgelistet.