Auf dem Barcamp in Frankfurt kam Timo Derstappen und mir in einem Track zu YAML den Dirk Jesse gehalten hat der Gedanke auf das Prinzip von Javadoc Kommentaren auch auf CSS zu übertragen. In PHP funktioniert die Anwendung von Javadoc Kommentaren ja schon ganz gut und recht ordentlich sieht das Ganze auch aus. Die Adaption dieses Modells nach CSS kann auch dort für ein wenig mehr Doku im Quellcode sorgen. Dazu ist aber die Frage wer wie Kommentare in CSS Dateien verwendet bzw. welche Bedeutung diese haben um mal ein Grundset an Tags vorzuschlagen.

Denn: In ganz einfacher Weise kann das Konzept ja in CSS schon ohne grosse Umstände benutzt werden: Ein Javadoc Kommentar fängt mit /** an und bildet dann einen Block der in der letzten Zeile mit */ abgeschlossen wird. Das ganze in den Zeilen dazwischen nett eingerückten *-chen macht den Block perfekt. Sogenannte Tags werden dann innerhalb des Blocks eingefügt. Sie beginnen immer mit einem @ Zeichen. Beispiel im Ganzen welches so auch aus einer CSS-Datei entnommen worden sein könnte (Warnung: Unser Syntax-Plugin zerstört die korrekte Einrückung der Kommentare):

Ich verwende die manchmal um Sektionen zu definieren. Fast obligatorisch ist ja der Reset Block am Anfang geworden. Aber mit Sektionen meine ich auch bestimmte Bereiche der Seite wie z.B. ein Contentbereich für Fliesstexte (h1-h6, p, ul etc.). Für Layout im generellen halte ich mir auch gerne Pixel-Brücken vor die nun mitlwerweile extremst oldskool sind und eher in em umgerechnet werden sollten. Aber das nur am Rande. Von der Verwendung her verdeutlicht der Beispielcode sicherlich wohin das gehen kann.

Nach der Vorstellung der Idee in diesem Artikel und der daraus entstandenen Diskussion sind in einem englischen Artikel noch weitere Informationen zusammengefasst: Javadoc for CSS.

Der Beitrag wurde am Donnerstag, den 17. Mai 2007 um 04:49 Uhr veröffentlicht und wurde unter CSS, Home, Material abgelegt. Du kannst die Kommentare zu diesen Eintrag durch den RSS 2.0 Feed verfolgen. Du kannst einen Kommentar schreiben, oder einen Trackback auf deiner Seite einrichten.