we:comment mehr als nur Kommentare

Bereits seit webEdition 6.2 gibt es das webEdition Tag <we:comment> und das Universal-Attribut comment für allen anderen webEdition Tags. Sowohl das Attribut als auch das Tag dienen in erster Linie dazu den Template-Code besser zu dokumentieren und dadurch leichter pfleg- und erweiterbar zu machen.

Im Gegensatz zu PHP- und HTML-Kommentaren, mit denen vor der Einführung des neuen Tags der Code dokumentiert wurde, können mit <we:comment></we:comment> Code-Bestandteile umschlossen und das Ausführen des Codes verhindert werden. Über das optionale Attribut type=““ lassen sich auch gezielt HTML-, PHP-, XML- und JavaScript-Kommentare erzeugen.

<we:comment type="html|xml|js|php">
... der hier enthaltene Code wird nicht ausgeführt ...
</we:comment>

Mit dem Universal-Attribut lassen sich bei jedem webEdition Tag hilfreiche Kommentare hinzufügen. Nutzt man beispielsweise <we:if…> und <we:else/> Tags, kann man hier schnell erfassen, was eigentlich welcher Zweig tun soll.

<we:ifVar type="global" name="authorExists" match="true" operator="equal" comment="Autor existert und kann angezeigt werden">
...
<we:else comment="Autor existiert nicht, zeige Verleger">
...
<we:ifVar>

Hilfreich ist das comment-Attribut auch bei der Verwendung von <we:include/> Hier arbeiten Entwickler oft mit der Angabe von IDs und wissen später nicht, welches Template sich dahinter verbirgt.

<we:include type="template" id="23" comment="/pfad/zum/template"/>

Wer bisher noch nicht mit <we:comment> oder dem gleichnamigen Universal-Attribut gearbeitet hat, sollte dies unbedingt ändern. Besonders während der Entwicklung lassen sich Code-Bausteine damit umschließen und das Ausführung unterdrücken, was zusammen mit dem Error-Log zu einer schnelleren Fehlerbeseitigung führen kann.