Codekonventionen - Versionsgeschichte

Solveig: /* Notationsbegriffe */

2016-08-17T11:33:25Z

‎Notationsbegriffe

Kristin: /* Beispiele */

2016-07-09T22:42:05Z

‎Beispiele

Kristin: /* Konventionen für Einrückung und geschweifte Klammern in Java */

2016-07-09T22:38:58Z

‎Konventionen für Einrückung und geschweifte Klammern in Java

Kristin: /* Konventionen für Bezeichner in Java */

2016-07-09T22:29:34Z

‎Konventionen für Bezeichner in Java

Kristin: /* Notationsbegriffe */

2016-07-09T22:28:14Z

‎Notationsbegriffe

Hauer: /* Konventionen für Einrückung und geschweifte Klammern in Java */

2016-07-09T00:01:31Z

‎Konventionen für Einrückung und geschweifte Klammern in Java

Hauer: /* Konventionen für Einrückung und geschweifte Klammern in Java */

2016-07-08T22:03:23Z

‎Konventionen für Einrückung und geschweifte Klammern in Java

Hauer am 8. Juli 2016 um 21:57 Uhr

2016-07-08T21:57:13Z

Kristin am 13. Juni 2016 um 21:35 Uhr

2016-06-13T21:35:19Z

Änderungen zeigen

Hauer: /* Konventionen für Bezeichner in Java */

2015-10-05T08:46:26Z

‎Konventionen für Bezeichner in Java

@@ Zeile 53: / Zeile 53: @@
 Im Zusammenhang mit '''Codekonventionen''' haben sich verschiedene Begriffe etabliert:
-'''Lower-Case''' (''engl.'' für "Kleinbuchstaben"): Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, während alle Buchstaben klein geschrieben werden.
+'''Lower-Case''' (''engl.'' für "Kleinbuchstaben"): Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, wobei alle Buchstaben klein geschrieben werden.
 *z.B.: <code>nanosecondsinsecond</code>, <code>valueineuro</code>, <code>positionx</code>, <code>positiony</code>
-'''Upper-Case''' (''engl.'' für "Großbuchstaben"): Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, während alle Buchstaben groß geschrieben werden.
+'''Upper-Case''' (''engl.'' für "Großbuchstaben"): Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, wobei alle Buchstaben groß geschrieben werden.
 *z.B.: <code>NANOSECONDSINSECOND</code>, <code>VALUEINEURO</code>, <code>POSITIONX</code>, <code>POSITIONY</code>
-'''Camel-Case''': Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, während jeder Anfangsbuchstabe eines Wortes groß geschrieben wird.
+'''Camel-Case''': Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, wobei jeder Anfangsbuchstabe eines Wortes groß geschrieben wird.
 *z.B.: <code>NanosecondsInSecond</code>, <code>ValueInEuro</code>, <code>PositionX</code>, <code>PositionY</code>
-'''Mixed-Camel-Case''': Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, während jeder Anfangsbuchstabe eines Wortes groß geschrieben wird, bis auf der erste.
+'''Mixed-Camel-Case''': Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, wobei jeder Anfangsbuchstabe eines Wortes groß geschrieben wird, bis auf der erste.
 *z.B.: <code>nanosecondsInSecond</code>, <code>valueInEuro</code>, <code>positionX</code>, <code>positionY</code>

@@ Zeile 114: / Zeile 114: @@
 = Beispiele =
 <source lang="java" title="Korrekte Vorgabe">
@@ Zeile 121: / Zeile 123: @@
+}
 </source>
 <source lang="java" title="Schlecht: Keine Einrückung">
@@ Zeile 156: / Zeile 172: @@
              /* Berechung */
+         }
+     }
+}
 </source>

@@ Zeile 109: / Zeile 109: @@
 </source>
-Ob Sie die öffnenden Klammern eines Blockes in die Zeile des ihn öffnenden Ausdruckes schreiben (wie im vorherigen Beispiel), oder die öffnende Klammer in die gleiche Ebene wie der den Block öffnende Ausdruck in einer einzelnen Zeile notieren (wie im lesbareren Beispiel unter Verständlichkeit eines Algorithmus) ist Ihnen überlassen. Sie sollten dabei aber auf jeden Fall konstant bleiben.
+Es gibt zwei Möglichkeiten die '''öffnenden Klammern''' eines Blockes zu notieren. Zum einen können sie in der '''gleichen Zeile''' wie der öffnende Ausdruck stehen (siehe vorheriges Beispiel), zum anderen können sie in einer eigenen Zeile aber auf der '''gleichen Ebene''' wie besagter Ausdruck notiert werden (siehe Verständlichkeit, Beispiel 3).
 = Beispiele =

@@ Zeile 87: / Zeile 87: @@
 *z.B.: <code>calculate(int x, int y)</code>, <code>doSomething()</code>, <code>cleanupAtShutdown(String message)</code>
-. Klassenweite '''Konstanten'' werden im '''Underscored-Upper-Case''' notiert.
+. Klassenweite '''Konstanten''' werden im '''Underscored-Upper-Case''' notiert.
 *z.B.: <code>PI</code>, <code>NANOSECONDS_IN_SECOND</code>, <code>ARRAY_SIZE</code>

@@ Zeile 56: / Zeile 56: @@
 *z.B.: <code>nanosecondsinsecond</code>, <code>valueineuro</code>, <code>positionx</code>, <code>positiony</code>
-'''Upper-Case'''(''engl.'' für "Großbuchstaben"): Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, während alle Buchstaben groß geschrieben werden.
+'''Upper-Case''' (''engl.'' für "Großbuchstaben"): Bezeichner werden als eine zusammenhängende Zeichenkette hintereinander geschrieben, während alle Buchstaben groß geschrieben werden.
 *z.B.: <code>NANOSECONDSINSECOND</code>, <code>VALUEINEURO</code>, <code>POSITIONX</code>, <code>POSITIONY</code>

@@ Zeile 97: / Zeile 97: @@
 == Konventionen für Einrückung und geschweifte Klammern in Java ==
-In Java wird, wie auch in vielen anderen Programmiersprachen, '''blockebenenweise''' eingerückt. Eine Ebene wird dabei meist mit vier Leerzeichen oder einem Tab eingerückt. Das bedeutet, dass die Anzahl an umgebenden [[Block|Blöcken]] von geschweiften Klammern die Anzahl an Leerzeichen oder Tabs vor dem Beginn einer Zeile vorgibt. So stehen z.B. die Deklarationen von Attributen und Methoden immer im Block der sie beinhaltenden Klasse und werden deswegen um eine Ebene eingerückt:
+In Java wird, wie auch in vielen anderen Programmiersprachen, '''blockebenenweise''' eingerückt. Eine Ebene wird dabei meist mit vier Leerzeichen oder einem Tab eingerückt. Das bedeutet, dass die Anzahl an umgebenden [[Block|Blöcken]] die Anzahl an Leerzeichen oder Tabs vor dem Beginn einer Zeile vorgibt. So stehen z.B. die Deklarationen von Attributen und Methoden immer im Block der sie beinhaltenden Klasse und werden deswegen um eine Ebene eingerückt:
 <source lang="java">

@@ Zeile 97: / Zeile 97: @@
 == Konventionen für Einrückung und geschweifte Klammern in Java ==
-In Java wird, wie auch in vielen anderen Programmiersprachen, '''blockebenenweise''' eingerückt. Das bedeutet, dass die Anzahl an umgebenden [[Block|Blöcken]] von geschweiften Klammern die Anzahl an Leerzeichen oder Tabs vor dem Beginn einer Zeile angibt. So stehen z.B. die Deklarationen von Attributen und Methoden immer im Block der sie beinhaltenden Klasse und werden deswegen um eine Ebene eingerückt:
+In Java wird, wie auch in vielen anderen Programmiersprachen, '''blockebenenweise''' eingerückt. Eine Ebene wird dabei meist mit vier Leerzeichen oder einem Tab eingerückt. Das bedeutet, dass die Anzahl an umgebenden [[Block|Blöcken]] von geschweiften Klammern die Anzahl an Leerzeichen oder Tabs vor dem Beginn einer Zeile vorgibt. So stehen z.B. die Deklarationen von Attributen und Methoden immer im Block der sie beinhaltenden Klasse und werden deswegen um eine Ebene eingerückt:
 <source lang="java">
 public class Cube {
-     private int x,y,z;
+     private int x,y,z; //Umgeben vom Block der Klasse: Einrückung um eine Ebene.
      private int calculateVolume(){
-         /* Berechnung */
+         /* Berechnung umgeben vom Block der Klasse und der Methode: Einrückung um zwei Ebenen. */
+     }
+}

@@ Zeile 93: / Zeile 93: @@
 Alles was einen '''Wert''' besitzt, kann so schnell durch den '''Kleinbuchstaben''' am Anfang erkannt werden kann, während von Typen mit Großbuchstaben unterschieden werden kann. Konstanten fallen schnell ins Auge.
-Bei '''Paketnamen''' kann durch die Form der Notation bei Großprojekten insbesondere erkannt werden, in welcher Sprache das Projekt dokumentiert ist. Für das Anlegen von Klassen zu den Übungsblättern reicht jedoch etwas wie <code>eini.blatt01</code> vollkommen aus.
+Bei '''Paketnamen''' kann durch die Form der Notation bei Großprojekten insbesondere erkannt werden, in welcher Sprache das Projekt dokumentiert ist (Ländercode der "URL"). Für das Anlegen von Klassen zu den Übungsblättern reicht jedoch etwas wie <code>eini.blatt01</code> vollkommen aus.
 == Konventionen für Einrückung und geschweifte Klammern in Java ==
-In Java wird, wie auch in vielen anderen Programmiersprachen, '''blockebenenweise''' eingerückt. Das bedeutet, dass die Anzahl an umgebenden Blöcken von geschweiften Klammern die Anzahl an Leerzeichen oder Tabs vor dem Beginn einer Zeile angibt. So stehen z.B. die Deklarationen von Attributen und Methoden immer im Block der sie beinhaltenden Klasse und werden deswegen um eine Ebene eingerückt:
+In Java wird, wie auch in vielen anderen Programmiersprachen, '''blockebenenweise''' eingerückt. Das bedeutet, dass die Anzahl an umgebenden [[Block|Blöcken]] von geschweiften Klammern die Anzahl an Leerzeichen oder Tabs vor dem Beginn einer Zeile angibt. So stehen z.B. die Deklarationen von Attributen und Methoden immer im Block der sie beinhaltenden Klasse und werden deswegen um eine Ebene eingerückt:
 <source lang="java">

@@ Zeile 57: / Zeile 57: @@
 Da wir im Praktikum des Modules Java programmieren, wollen wir, dass Sie folgende Konventionen einhalten:
 * Klassennamen werden im Camel-Case notiert. '''Beispiele''': <code>String</code>, <code>MeinProgramm</code>, <code>AbstractSingletonFactoryBean</code>
@@ Zeile 67: / Zeile 69: @@
 Dies sorgt dafür, dass alles was einen '''Wert''' besitzt schnell durch den Kleinbuchstaben am Anfang erkannt werden kann, während von Typen mit Großbuchstaben unterschieden werden kann. Konstanten nehmen dabei eine traditionelle Sonderrolle ein, damit sie schnell als solche identifiziert werden können.
 == Konventionen für Einrückung und geschweifte Klammern in Java ==