Projektgruppe Business Intelligence Applications and Evaluation ...

Projektgruppe Cuberunner
Jinengo – DV Konzept
4.4 Programmierrichtlinien
Programmierrichtlinien tragen maßgeblich dazu bei, den Code lesbarer und weniger fehleranfällig zu
gestalten. Zudem erleichtern einheitliche Richtlinien die Einarbeitung neuer Entwickler und sind daher
bei der Arbeit in Teams wichtiger Bestandteil der Softwareentwicklung. Die wichtigsten Richtlinien
sollen nachfolgend tabellarisch aufgeführt werden:
Richtlinie
Englisch als Entwicklungssprache
Dokumentation
Bezeichner
Globale Variablen
Modularisierung
Kodierung
Repository
Formatierung
Beschreibung
Sowohl für Funktions-, Klassen- und Variablennamen, als auch
für die Inline-Dokumentation wird durchgehend die englische
Sprache verwendet.
Jede Funktion und Klasse wird mit einer kurzen Dokumentation
zu versehen. Dazu gehört neben einer kurzen Beschreibung
auch die Auflistung der Übergabeparameter und Rückgabewerte.
Klassen sind zudem mit dem jeweiligen Autor zu kennzeichnen.
Klassen-, Funktions- und Variablennamen sind, sobald sie aus
mehreren Wörtern bestehen in der „CamelCase“-Notation zu
schreiben. Hierbei beginnt jedes Folgewort mit einem Großbuchstaben
gefolgt von Kleibuchstaben. Beispiel: getUserData().
Funktionen und lokale Variablen beginnen dabei immer
mit Kleinbuchstaben, Klassen mit Großbuchstaben. Die jeweiligen
Namen sind dabei so sprechend wir möglich zu wählen,
um die Verständlichkeit des Codes zu erhöhen.
Generell gilt es die Verwendung von globalen Variablen zu
verhindern und auf ein Minimum zu reduzieren.
Die Entwicklung soll so modular wie möglich erfolgen. Dies
bedeutet vor allem kurze, übersichtliche Klassen und Methoden
die möglichst wenig indirekte Abhängigkeit zueinander besitzen.
Es wird UTF-8 als einheitlicher Standard zur Zeichencodierung
genutzt und auf allen Entwicklungsumgebungen als Standardwert
eingestellt.
Jeder Entwickler hat das gemeinsame Git-Repository zu nutzen
und alle Änderungen am Quellcode noch am gleichen Tag in
das Repository zu laden. Zudem ist bei jedem Hochladen ein
kurzer Kommentar, der die Änderungen beschreibt, zu verfassen.
Es gilt den Code einheitlich zu formatieren. Hierzu zählt insbesondere
eine einheitliche Einrückung und Klammerung des
Codes. Entwickler die später in das Projekt einsteigen haben
sich an bestehende Konventionen zu halten.
Tabelle 4.8: Programmierrichtlinien
105