Ressourcen zu CSSDOC

Nach dem ersten Frankfurter Barcamp taten sich Dirk Jesse, Tom Klingenberg und Timo Derstappen zusammen, um einen Standard für Kommentare in CSS-Dateien zu erdenken. CSSDOC sollte es ermöglichen, Dokumentationen automatisiert zu erstellen. Vorbild war vor allem JavaDoc. Dirk, der es auch in seinem YAML einsetzt, schrieb darüber im Webkrauts-Adventskalender von 2007 einen einleitenden Artikel.

Ich habe in einem aktuellen, recht großen Projekt CSSDOC eingesetzt, obgleich nicht so variationsreich wie Dirk. Die wenigsten Tags wurden genutzt. Diese Art der Kommentierung hat auf alle Fälle die Übersichtlichkeit erhöht und schuf eine standardisierte Form des Informationsaustauschs mit meiner Kollegin.

Ende des letzten Jahres gab es auch einen kleinen Artikel in einem englischsprachigen Blog über CSSDOC. Mittlerweile gibt es ein paar Codesnippets für Editoren. Dirk kümmerte sich um Aptana, Frank Bültge nahm sich Ultraedit vor und Eric Eggert sowie neuerdings auch Olaf Gleba veröffentlichten Textmate-Bundles.
Leider ermöglicht mein derzeitiger Editor WeBuilder nicht den teilweisen Export von Snippets, sonst würde ich für diesen Editor etwas beitragen.

Der Standard ist interessant und schafft in umfangreicheren CSS-Dateien einen guten, strukturierten Überblick. Jetzt bleibt nur noch zu hoffen, daß es bald einen Parser für die Kommentare gibt, der aus diesen eine nette Dokumentation zusammenbaut. Vielleicht könnte ja das für jQuery geschriebene Tool „jQuery HTML Documentation Generator“ von Jörn Zaefferer eine gute Ausgangsposition dafür herstellen.

2 Responses to “Ressourcen zu CSSDOC”

  1. […] große Projekte und in Teams interessant: F-LOG-GE Blog Archive Ressourcen zu CSSDOC Für 1-Mann-Projekte wohl eher nicht. __________________ CSS lernen? Little […]

  2. […] zu dokumentieren ist nicht einfach. Jens verweißt auf den aktuelle Stand vom CSSDOC Projekt. Meiner Meinung nach ist der Standard zu […]