Kommentare in TypoScript
Gut strukturierter und kommentierter Templates erleichtern es den Überblick zu behalten.
Neben einen gut strukturierten TypoScript in einem Template ist es hilfreich mit "vernüftigen" Kommentaren die Lesbarkeit zu erhöhen.
TypoScript bietet die Möglichkeit von ein- und mehrzeiligen Kommentaren.
Einzeiliger Kommentar
Kurze Kommentare können mit den Zeichen # und // eingeleitet werden, ein schließendes Zeichen ist nicht nötig.
Der Kommentar muss immer in einer extra Zeile beginnen.
Richtige Schreibweise
// Kommentar beginnt in einer extra Zeile
# Kommentar beginnt in einer Zeile
Falsche Schreibweise
// Kommentar geht über
zwei Zeilen
# Kommentar geht über
zwei Zeilen
TS # Kommentar beginnt nicht in einer extra Zeile
TS // Kommentar beginnt nicht in einer extra Zeile
# Nach dem Kommentar folgt eine TS-Anweisung 10 = COA
// Nach dem Kommentar folgt eine TS-Anweisung 10 = COA
Mehrzeiliger Kommentar
Ein mehrzeiliger Kommentar wird mit /* geöffnet und mit */ wieder geschlossen. Es ist unbedingt darauf zu achten, die öffnenden und schließenden Zeichen in einer extra Zeile stehen. Auch darf weder vor dem öffnenden oder nach dem schließenden Zeichen TypoScript stehen.
Richtige Schreibweise
/*
Schließende Zeichen in einer extra Zeile
*/
/* Schließende Zeichen in einer extra Zeile
*/
Falsche Schreibweise
/* Schließende Zeichen müssen in einer extra Zeile stehen */
/*
Schließende Zeichen müssen in einer extra Zeile stehen */
TS /* Öffnene Zeichen müssen in einer extra Zeile stehen
*/
