Zum Hauptinhalt springen

Coding Guidelines

Diese Richtlinien definieren den Entwicklungsstandard der gesamten Platrona-Plattform.

Alle Projekte sollen denselben Qualitäts- und Strukturstandards folgen, um Wartbarkeit, Lesbarkeit und eine einheitliche Codebasis sicherzustellen.

Grundprinzipien

Jeder Code sollte:

  • leicht verständlich sein
  • nachvollziehbar aufgebaut sein
  • langfristig wartbar bleiben
  • möglichst einfach erweitert werden können

Code wird häufiger gelesen als geschrieben.

Deshalb steht Lesbarkeit immer im Vordergrund.

Allgemeine Regeln

Sprache​

  • Code wird grundsätzlich in Englisch geschrieben.
  • Kommentare werden ebenfalls in Englisch verfasst.
  • Benutzeroberflächen bleiben vollständig in deutscher Sprache.

Benennung​

Verwende immer aussagekräftige Namen.

✅ Gut

user_session
project_application
refresh_token

❌ Schlecht

a
tmp
test123
data1

Eine Aufgabe pro Klasse​

Jede Klasse besitzt eine klar definierte Verantwortung.

Mehrere unterschiedliche Aufgaben innerhalb derselben Klasse sollen vermieden werden.

Eine Aufgabe pro Funktion​

Funktionen sollen möglichst nur eine Aufgabe erfüllen.

Lange Funktionen sollten in kleinere Teilfunktionen aufgeteilt werden.

Python

Für Backend-Komponenten gelten folgende Konventionen:

Klassen​

UserService
ProjectManager
EmailService

Funktionen​

create_user()

send_email()

verify_login()

Variablen​

refresh_token

login_history

device_name

Konstanten​

MAX_LOGIN_ATTEMPTS

DEFAULT_SESSION_TIMEOUT

React / TypeScript

Komponenten​

LoginPage

DashboardCard

UserTable

Hooks​

useAuth();

useUser();

useProjects();

Variablen​

currentUser;

selectedProject;

isLoading;

API

Alle API-Endpunkte orientieren sich an REST-Konventionen.

Beispiele:

GET

POST

PUT

DELETE

Antworten sollen immer konsistent aufgebaut sein.

Kommentare

Kommentare sollen erklären warum etwas gemacht wird.

Nicht was der Code bereits offensichtlich macht.

✅ Gut

# Prevent duplicate sessions for security reasons.

❌ Schlecht

# Increase counter
counter += 1

Logging

Fehler und wichtige Ereignisse werden protokolliert.

Log-Nachrichten sollen eindeutig und verständlich sein.

Dokumentation

Neue Funktionen gelten erst dann als vollständig, wenn sie dokumentiert wurden.

Die Dokumentation ist ein fester Bestandteil der Entwicklung.

Qualität

Vor jedem Merge sollte überprüft werden:

  • Ist der Code verständlich?
  • Ist die Lösung nachvollziehbar?
  • Ist sie wartbar?
  • Wurde sie dokumentiert?
  • Ist sie getestet?

Grundsatz

Qualität ist wichtiger als Geschwindigkeit.

Eine saubere und stabile Lösung ist langfristig wertvoller als eine schnelle Umsetzung.

Jede Codezeile repräsentiert die Qualität der gesamten Plattform.