Entwicklungsrichtlinien
erstellt von Veit Schiele
—
zuletzt verändert:
21.09.2007 11:34
© Veit Schiele 2006
Entwicklungsrichtlinien für Zope Page Templates (ZPT), CSS, Python, Tests und Versionsmanagement.
Allgemein
- Achten Sie auf die richtige Benennung.
- Verwenden Sie zum Einrücken keine Tabulatoren, da hierdurch das Editieren durch das ZMI erschwert wird, verwenden Sie stattdessen je 4 Leerzeichen;
- Verwenden Sie Unix Linebreaks;
Zope Page Templates (ZPT)
- nur geringe Funktionalität in ZPT (verwende stattdessen Python-Skripts);
- kein CSS in ZPT;
- i18n-Tags in ZPT;
- Validierung mit dem W3C Markup Validation Service und den WCAG-Richtlinien;
- Verwenden Sie CSS-background-images für Bilder, die nicht zum Inhalt der Seite gehören;
CSS
- nicht-explizit
Anpassungen werden hierdurch vereinfacht z.B.
.linkExternal anstatt div#columns div#column-content a.linkExternal
!important Nur verwenden wenn notwendig, und niemals ! important.
Kommentare
- Kommentare erster Ordnung
z.B.:
/* ** Accessability enhancements */ .skipToContent { ... }- Kommentare zweiter Ordnung
z.B.:
/* strange ie fix */ .actionMenu a { ... } .actionMenu a:hover { ... }- Kommentare dritter Ordnung
für einzelne Stildefinitionen, z.B.:
/* strange ie fix */ * html #portal-columns { ... }
Validierung
Mit dem CSS Validation Service sind alle CSS-Dateien zu validieren.
Python
- Weder HTML noch CSS in Python-Skripts;
Tests
- Schreiben Sie für jedes Feature und jeden Bugfix einen passenden Unit Test
- Führen Sie die Unit Tests des jeweiligen Produkts erfolgreich aus, bevor Sie die Änderungen auf den Server zurückschreiben;
Versionsmanagement
- Schreiben Sie aussagekräftige Kommentare, die nicht nur in ihrem Kontext verständlich sind; zumindest die ID des Bugs oder Features sollte enthalten sein;
