| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| software_entwicklung:programmierrichtlinen:java [2010-02-22 16:09] – zueger1 | software_entwicklung:programmierrichtlinen:java [2010-06-18 16:13] (aktuell) – gelöscht zueger1 |
|---|
| ====== Programmierrichtlinen für Java ====== | |
| |
| ===== Namensgebung ===== | |
| ^ Namen für ^ beginnen mit ^^ Beispiele ^ | |
| | Konstanten | Substantiv | Kleinbuchstaben | size, pwm, serialVersionUID | | |
| | System-Konstanten | | | PORTF, FPSCR, DDR, PI ((Konstanten aus Reference-, User- Manuals, etc. werden wenn möglich so übernommen, wie sie in diesen Quellen festgelegt sind, es sei denn, sie widersprechen der Java-Syntax. Wichtig ist, dass man diese rechnerunterstützt, case-sensitive (Ctrl-F) suchen kann.))| | |
| | Variablen | Substantiv | Kleinbuchstaben | version, wordSize | | |
| | | Adjektiv | Kleinbuchstaben | full, ready | | |
| | Fuktionen | Substantiv | Kleinbuchstaben | length() | | |
| | | Adjektiv | Kleinbuchstaben | full(), equal()((Name bezeichnet Fuktionswert))| | |
| | Methoden | Verb | Kleinbuchstaben | drawLine()((Imperativ))| | |
| | Klassen | Substantiv | Grossbuchstaben | File, FifoQueue, Stack | | |
| | Pakete | Substantiv | Kleinbuchstaben | java.io, ntb, target.ppc555 | | |
| |
| **Namenslänge:** Lokale, temporär verwendete Namen sollten kurz sein (z.B. m, k, len). Globale, wichtige Namen sollten sprechend, aber nicht zu lang sein (z.B. words, nofEntries). | |
| |
| **Sprache:** Wählen sie englische Namen. Sie sind meist kürzer als deutsche Namen und passen besser zu den englischen Schlüsselwörtern. Ausserdem können sie Programme mit englischen Namen leichter an Personen weitergeben, die kein Deutsch verstehen (z.B. über das Internet). | |
| |
| **Worttrennung:** Die Lesbarkeit von Namen, die aus mehreren Wörtern bestehen, wird durch entsprechende Gross-/Kleinschreibung (z.B. drawLine) verbessert, solche Bezeichner werden vom Leser rascher als Einheit erfasst und können besser von Parameterlisten unterschieden werden, als die Trennung mit Unterstrichen, z.B. draw_line. Die letztere Variante hat ihre Wurzeln in der Zeit, als die "Schnell-Drucker" nur Grossbuchstaben drucken konnten. | |
