Warum Namenskonventionen wichtig sind
Wie Variablen-, Funktions- und Klassennamen im Code geschrieben werden, ist nicht bloß Geschmackssache. Eine einheitliche Namenskonvention macht Code lesbar, erleichtert die Teamarbeit und sorgt für einen konsistenten Stil. Verschiedene Sprachen haben unterschiedliche Gepflogenheiten; ein Vermischen wirkt unprofessionell.
Häufige Namenskonventionen
camelCase
Das erste Wort klein, jedes folgende Wort mit großem Anfangsbuchstaben:
firstName
lastName
getUserInfo
isLoggedIn
Verwendung: JavaScript/TypeScript-Variablen und -Funktionen, Java-Methoden und -Variablen, C#-Methoden und -Variablen.
PascalCase / UpperCamelCase
Jedes Wort beginnt groß:
FirstName
UserService
HomeController
Verwendung: JavaScript/TypeScript-Klassen und -Schnittstellen, Java-Klassen, C#-Klassen und -Methoden, React-Komponenten.
snake_case
Alle Wörter klein, durch Unterstrich getrennt:
first_name
last_name
get_user_info
Verwendung: Python-Variablen und -Funktionen, Ruby-Variablen und -Methoden, Datenbankfeldnamen, PHP-Variablen.
UPPER_SNAKE_CASE / SCREAMING_SNAKE_CASE
Alles groß, durch Unterstrich getrennt:
MAX_RETRY
DEFAULT_TIMEOUT
API_BASE_URL
Verwendung: Konstanten, Konfigurationseinträge, Enum-Werte. Nahezu jede Sprache nutzt diese Konvention für Konstanten.
kebab-case
Alles klein, durch Bindestrich getrennt:
first-name
user-profile
api-key
Verwendung: URL-Pfade, HTML/CSS-Klassennamen, Dateinamen, Schlüssel in Konfigurationsdateien.
dot.case
Durch Punkt getrennt:
user.name
config.timeout
Verwendung: hierarchische Schlüssel in Konfigurationsdateien, Namensräume.
Schnellübersicht nach Sprache
JavaScript / TypeScript
- Variablen, Funktionen: camelCase (getUserInfo)
- Klassen, Schnittstellen, Typen: PascalCase (UserService)
- Konstanten: UPPER_SNAKE_CASE (MAX_RETRY)
- Private Mitglieder: Unterstrich-Präfix camelCase (_privateVar)
Python
- Variablen, Funktionen: snake_case (get_user_info)
- Klassen: PascalCase (UserService)
- Konstanten: UPPER_SNAKE_CASE (MAX_RETRY)
- Private Mitglieder: Unterstrich-Präfix snake_case (_private_var)
Java
- Variablen, Methoden: camelCase (getUserInfo)
- Klassen: PascalCase (UserService)
- Konstanten: UPPER_SNAKE_CASE (MAX_RETRY)
- Paketnamen: durchgehend klein (com.example.service)
CSS / HTML
- Klassennamen: kebab-case (user-profile)
- IDs: kebab-case oder camelCase (Teamentscheid)
Datenbank
- Tabellen-, Feldnamen: snake_case (user_name)
- camelCase ebenfalls verbreitet, je nach Teamkonvention
URL
- Pfade: kebab-case (/user-profile/settings)
- Abfrageparameter: camelCase oder snake_case (?userId=123 oder ?user_id=123)
Umwandlungsregeln
camelCase → snake_case
- Großbuchstaben finden
- Unterstrich vor den Großbuchstaben einfügen
- alles in Kleinbuchstaben umwandeln
Beispiel: getUserInfo → get_user_info
snake_case → camelCase
- Unterstriche finden
- Buchstabe nach dem Unterstrich groß schreiben
- Unterstrich entfernen
Beispiel: get_user_info → getUserInfo
PascalCase → camelCase
Anfangsbuchstaben klein, Rest unverändert.
Beispiel: UserService → userService
camelCase → PascalCase
Anfangsbuchstaben groß, Rest unverändert.
Beispiel: userService → UserService
kebab-case → camelCase
- Bindestriche finden
- Buchstabe nach dem Bindestrich groß schreiben
- Bindestrich entfernen
Beispiel: user-profile → userProfile
Häufige Fehler
Konventionen mischen
Im selben Projekt camelCase und snake_case zu mischen, wirkt chaotisch. Eine Konvention wählen und beibehalten.
Behandlung von Abkürzungen
Abkürzungen durchgehend groß?
- URL oder Url? userId oder userID?
- Gepflogenheit: zweibuchstabige Abkürzungen groß (ID, URL), ab drei Buchstaben Anfangsbuchstabe groß (Http, Xml)
- Team einheitlich entscheiden; entscheidend ist projektwite Konsistenz
Akronyme
Wie werden HTTP, XML, URL in camelCase geschrieben?
- Empfohlen: httpUrl, xmlParser (als normales Wort behandelt)
- Andere: HTTPUrl, XMLParser (Abkürzung groß belassen)
- Team einheitlich
Behandlung von Zahlen
user2name oder user2Name?
- camelCase: user2Name (Wort nach der Zahl mit großem Anfangsbuchstaben)
- snake_case: user2_name
Mit DocsAll die Schreibweise umwandeln
Das Werkzeug zur Umwandlung der Groß-/Kleinschreibung unterstützt:
- Alles groß / alles klein
- Anfangsbuchstabe groß
- camelCase / PascalCase / snake_case / kebab-case wechselseitig umwandeln
- Satzanfang groß
Vorgehen:
- Text einfügen
- Umwandlungstyp wählen
- Ergebnis kopieren
Umwandlung im Browser, Text wird nicht hochgeladen.
Zusammenfassung
Für Namenskonventionen gilt: Variablen und Funktionen in camelCase oder snake_case (je nach Sprache), Klassen in PascalCase, Konstanten in Großbuchstaben mit Unterstrich, URL in kebab-case. Teamweite Einheitlichkeit ist am wichtigsten. Das DocsAll Werkzeug zur Umwandlung der Groß-/Kleinschreibung läuft im Browser, Daten werden nicht übertragen.