Gibt es eine Java-Methode, die Konventionen festlegt?

Question

Ich habe eine große Klasse (40 oder so Methoden), die Teil eines Pakets ist, das ich als Kursarbeit einreichen werde. Momentan sind die Methoden in Bezug auf den Nutzen öffentlich/privat usw. ziemlich durcheinander und ich möchte sie auf eine vernünftige Art und Weise bestellen. Gibt es eine Standardmethode, dies zu tun? Z.B. normalerweise werden Felder vor Methoden aufgelistet, Konstruktoren werden vor anderen Methoden aufgeführt, und getters/setters zuletzt; Was ist mit den übrigen Methoden?

Answer 1

Einige Konventionen listen zuerst alle öffentlichen Methoden auf, dann alle privaten - das bedeutet, dass es einfach ist, die API von der Implementierung zu trennen, auch wenn keine Schnittstelle vorhanden ist, wenn Sie sehen, was ich meine.

Eine andere Idee besteht darin, verwandte Methoden zu gruppieren - dies erleichtert es, Nähte zu erkennen, bei denen Sie Ihre vorhandene große Klasse in mehrere kleinere, zielgerichtetere aufteilen können.

Answer 2

40 Methoden in einer einzelnen Klasse ist ein bisschen viel.

Wäre es sinnvoll, einen Teil der Funktionalität in andere - entsprechend benannte - Klassen zu verschieben. Dann ist es viel einfacher zu verstehen.

Wenn Sie weniger haben, ist es viel einfacher, sie in einer natürlichen Lesereihenfolge aufzulisten. Ein häufiges Paradigma ist, Dinge entweder vor oder nach aufzulisten Sie brauchen sie, in der Reihenfolge, die Sie sie brauchen.

Dies bedeutet normalerweise, dass main() oben oder unten geht.

Answer 3

Verwenden Sie Eclipse? Wenn dies der Fall ist, würde ich mich an die Standardsortierreihenfolge halten, da dies wahrscheinlich derjenige ist, der Ihren Code liest (obwohl es nicht meine bevorzugte Sortierreihenfolge ist).

Answer 4

Meine "Konvention": statisch vor der Instanz, öffentlich vor private, Konstruktor vor Methoden, aber Hauptmethode unten (falls vorhanden).

Answer 5

Nicht sicher, ob es einen allgemein anerkannten Standard gibt, aber meine eigenen Präferenzen sind;

• Konstruktoren erster
• statische Methoden Als nächste, wenn es eine Hauptmethode, immer vor der anderen statischen Methoden
• Methoden nicht statisch nächsten, in der Regel in der Reihenfolge der Bedeutung der durch beliebiges Verfahren gefolgt Verfahren, dass es Anrufe. Dies bedeutet, dass öffentliche Methoden, die andere Klasse Methoden aufrufen, erscheinen nach oben und private Methoden, die keine anderen Methoden aufrufen, in der Regel auf den unteren
• Standardmethoden wie toString, equals und hashcode nächsten
• Getter und Setter haben einen besonderen Platz am Ende reservierte zuunterst der Klasse

Answer 6

Je präziser Link «Codekonventionen» zu: «Class and Interface Declarations»

Answer 7

1. Klasse (statische) Variablen: Zuerst die öffentlichen Klassenvariablen, dann die geschützt, und dann die private.

2. Instanzvariablen: Erst öffentlich, dann geschützt und dann privat.

3. Konstrukteurs

4. Methoden: Diese Methoden sollten nach Funktionalität gruppiert werden eher als durch Umfang oder Zugänglichkeit. Zum Beispiel kann eine private Klassenmethode zwischen zwei öffentlichen Instanzmethoden liegen. Das Ziel ist es, lesen und verstehen den Code einfacher.

Quelle: http://www.oracle.com/technetwork/java/codeconventions-141855.html

Answer 8

Auch Eclipse bietet die Möglichkeit, die Teilnehmer für Sie zu sortieren, wenn Sie aus irgendeinem Grund sie gemischt:

Ihre Klassendatei öffnen, die unterwegs zu „Source "im Hauptmenü und wählen Sie" Mitglieder sortieren ".

von hier genommen: Sorting methods in Eclipse