Namenskonventionen / Coderegeln

Ordner- und Dateinamen

  • Kleinschreibung
  • Bindestriche
  • Twig Macros- und und Includes beginnen mit '_' (z.B. _article.html)
Min Files

Code

Generell

  • Ausreichend im Quellcode kommentieren
  • Code regelmäßig aufräumen (auskommentierte Zeilen löschen, console.logs entfernen, Naming immer sauber halten etc.)
  • Einrückungen mit Tabs
  • Kommentare und Bezeichner in Englisch

Twig

  • Alle Bezeichner im CamelCase (z.B. 'showMobileClass')

CSS

Die CSS Struktur orientiert sich an den Vorgaben von SMACSS. Wichtig ist immer, dass der Scope eines CSS-Selektors leicht zu erkennen ist, d.h. gehört er zu einem bestimmten Modul, Theme usw.

  • Alle Bezeichner in Kleinschreibung mit Bindestrichen
  • Aufbau: Übergeordnetes Modul + Element: z.B. .teaser-list-head
  • Css-Klassen, die nur für genau ein Theme verwendet werden, sollten entsprechend prefixed werden. Beispiel: 'theme-trapez-overview-top-image'
  • Möglichst wenig Abkürzungen
  • Naming fortlaufend optimieren, um Nachvollziehbarkeit zu erhalten (Refactoring)  

JavaScript

  • Alle Bezeichner im CamelCase (z.B. 'showMobileClass')
  • Einheitlicher Header für Functions
  • Möglichst wenig Abkürzungen
  • Namensraum 'DW' verwenden für Klassen und Globals
Js
JavaScript Beispiel

Control Panel

  • Felder, die speziell für ein Theme angelegt werden, sollten als solche erkennbar sein. Beispiel:  themeTrapezOverviewTopVpImage
Teilen