3.6| ViewHelper: Comment – Kommentieren von Code

Nun zum vorletzten ViewHelper. Den ViewHelper Comment. Dieser hilft und Kommentare in unseren Template Dateien zu hinterlassen, die im Frontend für den Benutzer aber nicht sichtbar sind.

Kommentare im Code sind sehr nützlich. Gerade damit man selber auch nach 1 oder 2 Jahren bzw manchmal auch 1 bis 2 Monaten noch versteht was man da damals gemacht hat. Außerdem ist es dann auch für andere Programmierer die an z.B. mit an dem Projekt arbeiten, leichter nachzuvollziehen, was du da gemacht hast…
Es ist deshalb hilfreich, ein paar hilfreiche Kommentare mit dem ViewHelper Comment im Template zu hinterlassen. Über verweise, Pfade oder sonstige Maßnahmen.

In Typo3 Fluid werden Kommentare mit folgendem ViewHelper eingeleitet und angezeigt:

<f:comment> 
    Dies ist ein Kommentar, der nicht im Frontend ausgegeben wird.
</f:comment>

Dieser Kommentar ist nur für User sichtbar, die Zugriff auf die Template Dateien via FTP haben. Niemand anders kann diesen Kommentar lesen.

Im Gegensatz zum normalen HTML Kommentar:

<!-- Dies ist ein Kommentar der im Frontend angezeigt wird -->

Dieser Kommentar ist für alle lesbar im Frontend hinterlegt. Die meisten Browser lassen solche Kommentare durch druck auf die F12 Taste einsehen.

Der ViewHelper Comment erlaubt also Kommentare, die nur in den Template Dateien von Fluid einsehbar sind und somit nur von Usern gelesen werden kann, die es sollen. Die Öffentlichkeit kann diesen Kommentar nicht lesen.

Typo3 CMS 6.1 FLUID Template programmieren:

Marvin Sengera

Hey! Ich bin Marvin Sengera, Inhaber der Internetagentur "Binärfabrik" aus Paderborn. Ich habe mein Bachelorstudium Informatik mit Schwerpunkt Industriespionage an der Hochschule Hamm Lippstadt abgeschlossen und absolviere derzeit meinen Master in Fachrichtung "Technical Entrepreneurship and Innovation". Ich beschäftige mich rund um die Themen Informatik, Innovation & Unternehmensgründung.

Das könnte dich auch interessieren …

Schreibe einen Kommentar