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