Java Grundlagen: Konventionen, wie benenne ich Klassen, Methoden und Variablen

Posted: Februar 21st, 2010 | Filed under: Programmieren | Tags: , , , | 8 Comments »

Allgemein

Bezeichner

Bezeichner sind die Namen der Java Klassen, Interfaces, Variablen, Objekte, Methoden und Konstanten.

Was ist überhaupt erlaubt?

  • Alle Unicode Alphabete (z.B.:  a-z, A-Z, 0-9, ä, é, ب (Arabisch), β (Griechisch))
  • Nummern (jedoch nicht am Anfang)
  • Währungssymbole
  • Unterstrich  _
  • kein Schlüsselwörter erlaubt (z.B.: public nicht benutzen)
  • keine Leerzeichen erlaubt

Beispiele

erlaubt, nicht erlaubt

  • String
  • S t r i n g
  • i17
  • i&17
  • بρετη
  • 123456
  • MAX_VALUE
  • max-value
  • Public
  • public
  • $Dollarzeichen
  • #lol
  • _lol

Was sollte man benutzen (Konvention) ?

Die folgenden Kriterien gelten für alle Bezeichner. Also Klassen, Methoden, Variablen und Interfaces.

  • Ausschließlich a-z, A-Z, 0-9
  • _ (Unterstrich) nur einmal in Folge verwenden und nie allein

Beispiele

Konvention berücksichtigt, Konventionsverstoß

  • String
  • بρετη
  • i17
  • _
  • MAX_VALUE
  • MAX__VALUE
  • Public
  • $Dollarzeichen

Klassen (Konventionen)

  • Erster Buchstabe immer groß
  • CamelCase – Schreibweise (bei mehreren Wörtern den jeweiligen Anfangsbuchstaben groß schreiben, z.B.: BierZapfanlage)
  • Möglichst nur Nomen (Substantive) (z.B.: Bier) verwenden
  • Möglichst aussagekräftige Namen
  • Möglichst keine Abkürzungen

Beispiele

Konvention berücksichtigt, Konventionsverstoß

  • String
  • string
  • Bier
  • Trinken
  • BierBrauerei
  • Bier_Brauerei

Methoden (Konventionen)

  • Erster Buchstabe immer klein
  • CamelCase – Schreibweise (bei mehreren Wörtern den jeweiligen Anfangsbuchstaben groß schreiben den Rest immer klein, z.B.: bierZapfen)
  • Sollte aus Verben bestehen oder in Kombination mit Nomen (z.B.: bierTrinken)
  • Möglichst aussagekräftige Namen
  • Möglichst keine Abkürzungen

Konvention berücksichtigt, Konventionsverstoß

  • bierTrinken
  • auto

Variablen (Konventionen)

  • Erster Buchstabe immer klein
  • CamelCase – Schreibweise (bei mehreren Wörtern den jeweiligen Anfangsbuchstaben groß schreiben den Rest immer klein, z.B.: bierAlkoholgehalt)
  • Möglichst aussagekräftige Namen
  • Möglichst keine Abkürzungen

Beispiele

Konvention berücksichtigt, Konventionsverstoß

  • zahl
  • ζαηλ
  • kraftfahrzeug
  • kfz
  • pi
  • inPiUmrechnen
  • donauDampfschiffahrtsGesellschaft
  • z64

Interfaces (Konventionen)

  • Adjektive (z.B.: Trinkbar)