05 Nov 2007

Technikwürze 97 (S01/E97) Stylesheets dokumentieren mit CSSDOC

Wir arbeiten sauber, strukturiert, aber dokumentieren wir unseren Code? Wir sollten – auch CSS. David Maciejewski im Gespräch mit Dirk Jesse und Tom Klingenberg über CSSDOC.

Höre Technikwürze auf SoundCloud: Diese Folge | Alle Folgen

Die drei Dinge, die jeder Entwickler regelmäßig tun sollte, sind auch die drei Dinge, die er oder sie am wenigsten tun:

  • Erstelle Backups deiner Daten
  • Versioniere größere Webseiten
  • Dokumentiere deine Quelltexte.

Gerade letzteres ist, besonders im Team oder bei großen Webseiten, wichtig. PHP-Entwickler zum Beispiel nutzen bestimmt formatierte Kommentare, um Ihren Code zu dokumentieren. Dirk Jesse und Tom Klingenberg arbeiten an CSSDOC, einer Formatregel für CSS und reden darüber in dieser Sendung.

Mögliche Vorteile von CSSDOC

  • Gliederung in großen Projekten
  • Einheitliche Sprache zur Dokumentation von Bugfixes
  • Maschinenlesbar

Nachteile?

  • Mehrarbeit – ja, etwas?
  • Konflikt Dokumentation/Filesize?

Grundlagen CSSDOC

  • File- und Sectioncomments
  • Tags (erst hier wirds richtig spannend)

Tags

  • @author
  • @see
  • @version – alle drei in Verbindung mit Subversion sinnvoll
  • @revision
  • @lastmodified
  • Unterschied zwischen @bugfix / @workaround
  • @affected
  • @cssfor
  • @valid

Links zur Sendung

Tags: , ,

Dieser Beitrag wurde am Montag, 5. November 2007 um 00:00 Uhr in der Kategorie Podcast veröffentlicht.
Kommentare sind im Moment nicht erlaubt, du kannst aber einen Trackback von deiner Seite aus senden.

Kommentare

  • 1.
    Matt
    am 5. November 2007, 09:14 Uhr

    Vielleicht sollte man noch einen Link zu www.cssdoc.net hinzufügen :D

  • 2.
    macx
    am 5. November 2007, 09:26 Uhr

    natürlich! Vielen Dank!

  • 3.
    Thomas Schaaf
    am 5. November 2007, 14:02 Uhr

    Hey!

    Team Annie Way ist leider nicht bis zum Ende gekommen..

    CSSDOC hört sich interessant an, allerdings fände ich es viel cooler, wenn man innerhalb von CSS rechnen könnte z.B. width: 100%-200px.

    VS.Php wird auf jedem Fall mal gucken, ob man CSSDOC früher oder später integriert wird, kommt allerdings auch dadrauf an, ob es von Kunden angefragt wird.

    Wieder ein Bakeup :D Psst es heißt Ba(ä)ckup ;)

    Ist übrigens DARPA die das Auto haben will bzw. viel mehr die Technologie.

    Thomas

  • 4.
    Stefanie
    am 5. November 2007, 14:47 Uhr

    Danke, das war wieder sehr informativ.
    Dem “Bakeup” kann ich mich nur anschließen, ich denke da immer an backen und damit hats ja nicht wirklich was zu tun.

    Eine Frage an Jakob Nielsen:
    “How to deal with non-believers?”

    Gruß...

  • 5.
    datenkind
    am 6. November 2007, 16:11 Uhr

    Anfangs ist das Dokumentieren von CSS-Dateien irgendwie sehr gewöhnungsbedürftig. Wenn ich mir allerdings die Sachen von vor einigen Monaten anschaue, bevor ich dazu überging, ordentlich zu dokumentieren, große Dateien zu splitten etc. wird mir schon etwas übel. :)

    Mitterweile habe ich eigentlich mein eigenes Konzept, um CSS-Dateien zu kommentieren, allerdings klingt CSSDOC recht interessant.

  • 6.
    ruepel
    am 9. November 2007, 14:00 Uhr

    Sehr interessante Sendung, zumal ich mich vor einiger selbst gefragt wie man am Besten CSS dokumentieren kann, weil ich vor ähnlichen Problemen stand und ein altes Projekt ausgekramt habe und keine Ahnung mehr hatte wie es ging. Finde die einzelnen Aspekte bisher sehr gut und werde mich mal ausführlicher damit beschäftigen. Danke auch für den PHP Hinweis, war mir vorher gar nicht bekannt.

  • 7.
    silvio_l
    am 12. November 2007, 15:09 Uhr

    Hi,

    sehr vernünftiges Vorhaben einen Standard für die die Kommentierung von CSS zu erstellen. Werde ich auf jeden Fall unterstützen. Was mir bisher immer noch fehlt ist ein vernünftiger Notationsstandard. Habe mir selbst zwar schon lange einen angeeignet aber finde das man für eine optimale Lesbarkeit aller Stylesheets auch dort mal schauen kann. Schon allein für den Anfänger von CSS und XHTML ist es bestimmt sehr hilfreich soetwas zu Verfügung zu haben. Das erspart dem Nachfolger dann auch einiges an Herzrasen.

  • 8.
    Julia
    am 16. November 2007, 13:02 Uhr

    Ich kann mich da silvio_l nur anschließen. Gerade ich als Anfängerin empfinde die doch vielen unterschiedlichen Notationsmöglichkeiten als etwas verwirrend. Trotzdem möchte man auch als Einsteiger seine ersten und noch kleineren Projekte sorgfältig und sinnvoll strukturiert dokumentieren. Von daher begrüße ich sowohl einen Notationsstandard als auch die Idee zu CSSDOC sehr. Vielen Dank für eine mal wieder sehr informative Sendung!

    Viele Grüße.

  • 9.
    marc thiele
    am 28. November 2007, 12:07 Uhr

    Vielen Dank einmal mehr für die gelungene Sendung. Hat mir gefallen und war sehr informativ!

    Besten Gruß aus Düsseldorf und weiter so…

    marc

  • 10.
    Sabine
    am 4. Februar 2014, 11:50 Uhr

    Ich bin gerade dabei, mich näher mit CSS zu beschäftigen, daher kam mir dieser Beitrag gerade recht. Das Dokumentieren von CSS Dateien klappt bei mir nicht aufs erste Mal – liegt wahrscheinlich an mir. Ich muss mich erst daran gewöhnen, aber es wird schon werden. Leider wird auf CSSDOC aus meiner Sicht nicht ausführlich genug eingegangen, ich hätte gerne mehr darüber erfahren. Das klingt für mich als Anfänger nämlich recht interessant.

Dein eigener Kommentar

Die Kommentarfunktion für diesen Beitrag wurde deaktiviert.