Was vorstellbar ist, ist auch machbar.

Coding Standards – Basics

Ziel und Zweck:

Wir legen großen Wert auf strukturelle und ästhetische Übersichtlichkeit in den Programmcodes. Nur so bleiben komplexe Projekte auch nach Jahren und über mehrere Personen noch nachvollziehbar und wartbar. Die folgenden Punkte betrachten wir als Minimum an „must-have“.

1. Benamung

Alle Namen und Kommentare sind in englischer Sprache zu verfassen.

2. Kontext

CSS-Klassen oder PHP-Funktionen haben immer den folgenden Rahmen, d.h. am Ende der ersten Zeile ist immer ein Leerzeichen und die öffnende Klammer. Alle Elemente sind mit Tabs eingerückt und die schließende Klammer ist alleine auf der Ebene der Klasse bzw. Funktion.

Beispiele:

.css-class {
	width: 100%;
}
#css-id {
	width: 100%;
}
funktion {
	echo 'Hello World';
}

3. Formatierung

Alle Attribute in CSS haben folgende Eigenschaften:

  • Sie sind mit Tabs eingerückt.
  • Auf den Namen folgt ein Doppelpunkt und ein Leerzeichen.
  • Dann folgt der Wert mit einem abschließenden Strichpunkt.

Beispiele:

.css-class {
	width: 100%;
	background-image: url('../images/image.jpg');
}
Hinweis:
Das Ihnen vorliegende Dokument erhebt selbstverständlich keinen Anspruch auf Vollständigkeit, sondern möchte denjenigen als Orientierung dienen, die sich über das Thema informieren wollen.
Änderungsvermerke: V.1.0/2009-02-24/sd
Diese Version dient nur der Information und unterliegt NICHT dem Änderungsdienst.

Note:
Naturally, this document does not claim to be complete, but aims to serve as a starting point for all those who want to gather information on the subject.
Revision Note: V.1.0/2009-02-24/sd
This Version is for information purposes only and is NOT subject to revision service.