Unterschiede
Hier werden die Unterschiede zwischen der gewählten und der aktuellen Version gezeigt.
| start:info:11if:java_konventionen 08.09.2008 12:24 | start:info:11if:java_konventionen 23.10.2013 10:12 aktuell | ||
|---|---|---|---|
| Zeile 6: | Zeile 6: | ||
| Damit Code lesbar ist - undzwar nicht nur von einem selbst, sondern auch von Dritten - braucht man Vereinbarungen, an die sich alle halten. Diese sind für die Sprache nicht zwingend nötig, auch dem Computer ist es absolut egal, doch beschleunigen sie die Analyseprozesse für den Benutzer - nein, für __alle__ Benutzer. ;-)\\ | Damit Code lesbar ist - undzwar nicht nur von einem selbst, sondern auch von Dritten - braucht man Vereinbarungen, an die sich alle halten. Diese sind für die Sprache nicht zwingend nötig, auch dem Computer ist es absolut egal, doch beschleunigen sie die Analyseprozesse für den Benutzer - nein, für __alle__ Benutzer. ;-)\\ | ||
| - | Diese Vereinbarungen (auch Regeln) nennt man Konventionen, die hier aufgezeigt werden sollen. | + | Diese Vereinbarungen (auch Regeln) nennt man Konventionen.\\ |
| + | |||
| + | **Übrigens:** Sun hat schon an diese Konventionen gedacht und eine globale festgelegt. Es ist empfehlenswert sich daran zu halten: [[http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html|Code Conventions for the Java™ Programming Language]]\\ | ||
| + | |||
| + | Einige dieser Konventionen sollen hier nun aufgezeigt werden. | ||
| ===== Die goldenen Regeln der Code-Formatierung ===== | ===== Die goldenen Regeln der Code-Formatierung ===== | ||
| Zeile 12: | Zeile 16: | ||
| ==== Regel 1 ==== | ==== Regel 1 ==== | ||
| - | Zusammenhängende Blöcke (Teile) einrücken ((ein TAB bzw. mindestens 2 Leerzeichen)). | + | Zusammenhängende Blöcke (Teile) einrücken ((ein TAB bzw. mindestens 4 Leerzeichen)). |
| **Beispiel (falsch):** | **Beispiel (falsch):** | ||
| Zeile 28: | Zeile 32: | ||
| <code java> | <code java> | ||
| public static void unlesbar(int z) { | public static void unlesbar(int z) { | ||
| - | System.out.println("Hallo Welt."); | + | System.out.println("Hallo Welt."); |
| - | if (z < 3) | + | if (z < 3) |
| - | System.out.println("Schönes Wetter heute"); | + | System.out.println("Schönes Wetter heute"); |
| - | else | + | else |
| - | System.out.println("Mistwetter!"); | + | System.out.println("Mistwetter!"); |
| } | } | ||
| </code> | </code> | ||
| Zeile 43: | Zeile 47: | ||
| <code java> | <code java> | ||
| public static void unlesbar(int z) { | public static void unlesbar(int z) { | ||
| - | System.out.println("Hallo Welt."); | + | System.out.println("Hallo Welt."); |
| - | if (z < 3) System.out.println("Schönes Wetter heute"); | + | if (z < 3) System.out.println("Schönes Wetter heute"); |
| - | else System.out.println("Mistwetter!"); System.out.println("Ciao"); | + | else System.out.println("Mistwetter!"); System.out.println("Ciao"); |
| } | } | ||
| </code> | </code> | ||
| Zeile 52: | Zeile 56: | ||
| <code java> | <code java> | ||
| public static void unlesbar(int z) { | public static void unlesbar(int z) { | ||
| - | System.out.println("Hallo Welt."); | + | System.out.println("Hallo Welt."); |
| - | if (z < 3) | + | if (z < 3) |
| - | System.out.println("Schönes Wetter heute"); | + | System.out.println("Schönes Wetter heute"); |
| - | else | + | else |
| - | System.out.println("Mistwetter!"); | + | System.out.println("Mistwetter!"); |
| - | System.out.println("Ciao"); | + | System.out.println("Ciao"); |
| } | } | ||
| </code> | </code> | ||
| ==== Regel 3 ==== | ==== Regel 3 ==== | ||
| + | |||
| + | Sich öffnende geschweifte Klammern stehen am Ende des vorangehenden Befehls, sich schließende Klammern in einer eigenen Zeile. Es gilt: diese werden so eingerückt, dass sie mit dem Beginn der Zeile übgereinstimmen, in der die zugehörige offene Klammer steht. Außer bei ''do-while-''Schleifen darf in dieser Zeile kein weiterer Befehl stehen.\\ | ||
| FIXME | FIXME | ||
| Zeile 73: | Zeile 79: | ||
| ==== Regel 5 ==== | ==== Regel 5 ==== | ||
| - | FIXME | + | Klassen- und Konstruktornamen beginnen immer mit einem großen Buchstaben.\\ |
| + | |||
| + | Setzen sich Namen aus mehr als einem Wort zusammen, wird jedes Wort mit einem Großbuchstaben begonnen.\\ | ||
| + | In der Fachsprache heißt dies [[wpde>Camel_Caps]]\\ | ||
| + | |||
| + | <code java> | ||
| + | * MeineErsteKlasseDieIchProgrammiere | ||
| + | * Auto | ||
| + | * Auto() | ||
| + | * ... | ||
| + | </code> | ||
| ==== Regel 6 ==== | ==== Regel 6 ==== | ||
| - | FIXME | + | Variablen- und Methodennamen beginnen immer mit einem Kleinbuchstaben.\\ |
| + | |||
| + | Auch hier gilt: Setzen sich die Namen aus mehr als einem Wort zusammen, wird jedes Wort (außer dem ersten) mit einem Großbuchstaben begonnen.\\ | ||
| + | |||
| + | <code java> | ||
| + | * beispielMethode() | ||
| + | * gefahreneKm | ||
| + | * i | ||
| + | * ... | ||
| + | </code> | ||
| ==== Regel 7 ==== | ==== Regel 7 ==== | ||
| - | FIXME | + | Konstanten werden mit Großbuchstaben bezeichnet.\\ |
| + | |||
| + | Setzt sich eine Konstante aus mehreren Worten zusammen, werden diese durch Unterstriche voneinander getrennt. | ||
| + | |||
| + | <code java> | ||
| + | * GROESSTER_WERT_WO_GIBT | ||
| + | * PI_HALBE | ||
| + | * ... | ||
| + | </code> | ||
