0

Kommentare (Workaround v2)

Hallo zusammen.

Für Kommentare habe ich als Workaround schon ein paar mal folgenden Vorschlag gesehen:

let comment := "My Comment.";

 

Besser lesbar und sichtbar ist folgende Variante:

" // This is a multiline comment.
  // It can spend as many lines as you need.

  // Even empty lines are supported.";

 

Diese Version ist leichter lesbar. Zudem bringt ein Zeilenumbruch innerhalb eines Strings das Syntaxhighlighting durcheinander. Der String verliert seine typische rötliche Färbung. Die zwei Schrägstriche sorgen für eine dunkelgelbliche Färbung. Damit sind Kommentare also auf einen Blick als solche erkennbar.

Wer großen Wert drauf legt, dass Kommentare wie in den meisten Sprachen/Entwicklungsumgebungen grün gefärbt werden, kann ausserdem diese Variante verwenden:

"
/This is a green comment. To keep it green, you have to end it with another / and have to avoid using a // in the same line.
";

Da beim Posten wie vermutlich jedes Mal die Code-Formatierung verloren geht: Das letzte Beispiel in einen Formel-Editor kopieren sollte verdeutlichen, wie die Hervorhebung funktioniert. Ich benutze das jetzt schon seit ein paar Wochen und es macht mir den Scripting-Alltag deutlich leichter.
Ein letzter Hinweis vielleicht: Der Kommentar ist immer noch ein String, der in einer Funktion oder Formel als Rückgabewert fungieren würde, wenn darauf keine weitere Anweisung folgt, es gibt also vereinzelt stellen, an denen man diesen Hack nicht zum kommentieren verwenden kann. (Diese Einschränkung lässt sich mit einem hintenangestellten void; aber meistens kompensieren.)

Viel Spaß beim Kommentieren/Dokumentieren.
Sebastian

2 Antworten

null
    • Sebastian_Werner
    • vor 5 Jahren
    • Gemeldet - anzeigen

    (Es sollte naturlich heißen: "It can span", nicht "It can spend". Eine Editier-Funktion wäre wirklich Klasse.)

    • Leonid_Semik
    • vor 5 Jahren
    • Gemeldet - anzeigen

    Hallo Sebastian, 

    vielen Dank, werde ich sofort anwenden. 

    Leo

Content aside

  • vor 5 JahrenZuletzt aktiv
  • 2Antworten
  • 1826Ansichten