Gibt es eine Standardmethode zur Organisation von Methoden innerhalb einer Klasse?

Question

Es scheint viele verschiedene Möglichkeiten zu geben, Methoden in einer Klasse zu organisieren. Ich könnte Methoden nach Zugriff gruppieren und sie alphabetisch ordnen. Ich könnte verwandte Methoden zusammen gruppieren. Ich könnte eine Mischung aus beidem verwenden, oder etwas ganz anderes. Gibt es eine Standardmethode für diese Vorgehensweise? Wenn nicht, wie gehen Sie vor?

Answer 1

StyleCop setzt hier einige Dinge durch:

Innerhalb einer Klasse, Struktur oder Schnittstelle müssen die Elemente in der folgenden Reihenfolge angeordnet werden:

• Felder
• Konstrukteure
• Finalisten (Zerstörer)
• Delegierte
• Veranstaltungen
• Enums
• Schnittstellen
• Eigenschaften
• Indexer
• Methoden
• Strukturen
• Klassen

Außerdem sind die Elemente nach dem Zugriff geordnet:

• public
• internal
• protected internal
• protected
• private

Außerdem gibt es noch einige andere Regeln:

• Kontingente müssen vor Feldern erscheinen
• static Elemente müssen vor Instanz-Elementen erscheinen.

Dies könnte eine gute Ausgangsbasis für den Anfang sein. Was zusätzliche Ordnungsregeln angeht, so fasse ich verwandte Methoden in der Regel zusammen.

Answer 2

Was auch immer Sie tun, legen Sie es in Ihren Standards fest und seien Sie konsequent. Wir verwenden eine benutzerdefinierte Regionerate Konfiguration, um unsere Methoden anzuordnen. Alle Mitglieder des Teams verwenden dieselbe Konfiguration.

EDIT: Wir verwenden jetzt ReSharper 's Code-Bereinigung mit einem benutzerdefinierten Type Members Layout.

Answer 3

Ich benutze NArrange die das meiste von dem macht, was ich will: Gruppieren Sie Felder, Methoden... alphabetisch und nach Zugriffsmodifikatoren. Es erzwingt auch einige Style-Cop-Regeln (z.B. die Reihenfolge der Elementtypen, die Position der using-Anweisungen). NArrange ist bis zu einem gewissen Grad konfigurierbar, Sie müssen also nicht mit der Standardkonfiguration leben, wenn Sie sie nicht mögen.

Aktualisierung: Jetzt verwende ich Resharper, da NArrange mit der neueren C#-Syntax nicht korrekt funktioniert.

Answer 4

I group my methods by their access modifier 
and in the following sequence:

*   public 
*   internal 
*   protected internal
*   protected 
*   private

Answer 5

Da Visual Studio über Tools verfügt, mit denen man schnell zu Methoden nach Namen navigieren kann, ziehe ich es vor, private Mitgliedsvariablen und Konstruktoren ganz oben zu platzieren und Methoden nach Funktionalität zu gruppieren (d. h. Hilfsmethoden liegen nahe bei den Methoden, die sie aufrufen). Ich gruppiere auch Eigenschaften zusammen. Wenn eine Klasse umfangreich wird, verwende ich #region-Direktiven, um die Organisation zu zeigen.