Kommentare #

Diese Seite ist für Designer, die Templates dokumentieren.

Inhalt #

1. Template-Kommentare
2. Ein Kopfkommentar
3. Auskommentieren
4. Keine HTML-Kommentare

Template-Kommentare #

{* One line *}
{* Several
   lines *}

Template-Kommentare werden beim Kompilieren des Templates entfernt. Sie kosten zur Laufzeit nichts und erreichen nie Besucher.

Ein Kopfkommentar #

Die mitgelieferten Designs beginnen wichtige Templates mit einem Kommentar, der sagt, was das Template tut, welche Variablen es erwartet und warum es so geschrieben ist. Die pagelayout/head/style.tpl des Designs media erklärt ihre Dateireihenfolge und die Entscheidung zu den Schriften; das Pagelayout von starter listet seine pl_-Variablen. Tun Sie dasselbe:

{* Teaser of a node, used in lists and layout blocks.
   Parameters: node (required), show_image (default false), image_class (default 'medium').
   Prints an <article>; the heading level is h3 because lists sit under an h2. *}

Auskommentieren #

Umschließen Sie Code mit {* ... *}, um ihn abzuschalten; das Design simple hält alternative Menü-Includes auf diese Weise. Entfernen Sie toten Code vor einem Release, statt ihn lange auskommentiert stehen zu lassen.

Keine HTML-Kommentare #

<!-- ... --> wird an jeden Besucher geschickt, kann interne Notizen verraten und fügt Bytes hinzu. Verwenden Sie ihn nur, wenn der Kommentar für den HTML-Quelltext gedacht ist (selten). Um zu debuggen, welches Template was gezeichnet hat, verwenden Sie stattdessen Template-Pfadkommentare (Template-Pfadkommentare).

Verwandte Seiten #

• Template-Styleguide
• TPL-Syntax: Grundlagen
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.