Klassen Klassendesign - Deklarationsreihenfolge?

[jDennis79]

Hallo Forum,

mal eine kleine Stilfrage: In welcher Reihenfolge deklariert ihr die einzelnen Bestandteile (Klassenvariablen und -methoden, Instanzvariablen und -methoden, Getter und Setter, Konstruktoren)? Was haltet ihr für das Sinnvollste und Übersichtlichste und warum? Und macht ihr die einzelnen "Abschnitte" durch Kommentare kenntlich?

 

[Landei]

Ist in den Code Conventions beschrieben, und da halte ich mich ungefähr dran. Am wichtigsten finde ich, keine Variablen mitten zwischen den Methoden zu deklarieren. Zusammengehörige Methoden schreibe ich nah beieinander, unabhängig von den Modifiern. Keine Kommentare zwischen den Abschnitten.

 

[Gast2]

Ist in den Code Conventions beschrieben, und da halte ich mich ungefähr dran. Am wichtigsten finde ich, keine Variablen mitten zwischen den Methoden zu deklarieren. Zusammengehörige Methoden schreibe ich nah beieinander, unabhängig von den Modifiern. Keine Kommentare zwischen den Abschnitten.

Ich würde mich dem soweit anschließen, nur bei den Kommentaren denke ich kann es jeder halten wie er will solange es keine Romane sind.

Wenn man den Quellcode jedoch ohnehin mit Javadoc dokumentiert (was man unbedingt sollte!) gehen die Abschnitts Kommentare unter, daher lasse ich diese weg.

 

[Suinos]

Wenn ich etwas neues einfügen möchte, schreibe ich das einfach irgendwo an freien Platz, und lasse es mir dann von Eclipse sortieren (Sort Members... ->

SHIFT + ALT + S, M

), das ergibt in etwa diese Reihenfolge:

1. Innere Klassen
2. Statische Variablen
3. Statische Methoden
4. Variablen
5. Konstruktoren
6. Methoden

Untereinander ist alles schön alphabetisch sortiert.

Das funktioniert natürlich nur gut, solange man alleine an einer Sache arbeitet, und sich nicht um svn-conflicts wegen einer riesigen Sortierung kümmern muss *hust*.

Abschnitte braucht es nicht, da man mit einer IDE sowieso schnell das wichtigste sieht und dahin springen kann; was natürlich voraussetzt dass sich die Namen von Variablen und Methoden selber dokumentieren.