Wie organisieren Sie große Code-Dateien?

Question

Ich bin mir zunehmend bewusst, dass mein Code in jeder einzelnen Datei oft Hunderte von Zeilen umfassen kann, und obwohl ich weiß, dass die Implementierung solide ist, fühlt sie sich immer noch chaotisch und unorganisiert an.

Ich verstehe, dass es Situationen gibt, wo viel Code notwendig ist, aber was ist der beste Weg, um alles zu organisieren?

Ich habe darüber nachgedacht, Variablen von Methoden, private s von public s und internals zu trennen, aber ich will nicht, weil ich nicht helfen kann, zu denken, dass die Komponenten einer Klasse in einer Datei gehören.

Diese ganze Sache ist zusammengesetzt, wenn ich mit dem Codebehind eines WPF-Fensters arbeite, die immer mit einer exponentiellen Rate in einem riesigen Durcheinander sehr schnell zu wachsen scheinen.

Außerdem: C# hat ein Schlüsselwort namens partial, mit dem Sie eine Klasse über eine beliebige Anzahl von Dateien aufteilen können, ohne die Funktionalität zu beeinträchtigen. Mir ist jedoch aufgefallen, dass Microsoft anscheinend nur partial verwendet, um generierten Code vor Ihnen zu verbergen (Winforms/WPF). Das führt mich zu der Frage, ob das Teilen einer Klasse einfach weil es viele Zeilen hat, eine legitime Verwendung von partial ist - oder?

Danke

Answer 1

Trennen Sie Ihren Code in Verantwortlichkeiten. Definieren Sie für jede Verantwortung einen einzelnen Typ. Das heißt, folgen Sie der Single Responsibility Principal. Dies führt zu kleineren Codeeinheiten, von denen jede eine sehr spezifische Funktion ausführt. Dies führt nicht nur zu kleineren Dateien, sondern auch zu einem besseren Design und einer besseren Wartbarkeit.

Answer 2

Ich neige dazu, Eigenschaften, Konstruktoren, Methoden und Hilfsmethoden (private Methoden) zusammen mit Regionen zu gruppieren. Wenn ich viele Methoden habe, erstelle ich mehr Regionen basierend auf dem was sie tun (besonders gut für Überladungen). Und wenn Sie von Überlastungen sprechen, versuchen Sie, Ihren Code mit optionalen Parametern zu minimieren.

Soweit ich verstehe partiell bedeutet, dass die Klasse in zwei separaten Dateien existiert. Webforms und Steuerelemente sind partiell, da der andere "Teil" der Datei die zugehörige as [p | c] x-Datei ist.

Answer 3

Wenn Ihre Dateien groß sind, weil sie eine einzelne Klasse/Struktur enthalten, die groß ist, dann ist dies normalerweise (aber nicht immer) ein Hinweis darauf, dass Ihre Klasse mehrere Probleme behandelt und in eine Reihe kleinerer, mehr spezialisierte Klassen.

Answer 4

Ich gehe auf die Theorie, dass, wenn Sie eine ganze Methode auf einem Bildschirm sehen können (dh Sie müssen scrollen), sollten Sie die Methode in weitere Methoden brechen - entweder in der gleichen Klasse oder wenn der Code verwendet wird mehr als einmal in eine Helferklasse.

Answer 5

Wenn ich Sie verstehe, ist Ihr Hauptproblem, dass Ihre Formulare am Ende zu groß sind, was zu den Klassen für die Formulare mit zu viel Code führt, was ganz normal ist, wenn Ihre Formulare nicht sehr einfach sind. Um dies zu minimieren, verwenden Sie User Controls. Wenn Sie die Steuerelemente in andere Klassen verschieben, verschieben Sie den Code auch in andere Klassen.

Manchmal kann es etwas schwieriger werden, zwischen den Steuerelementen zu kommunizieren, aber das wird normalerweise mehr als wettgemacht durch die Tatsache, dass der Code in jeder Klasse viel leichter zu verstehen ist.

Answer 6

Wir verwenden stylecop. Es hilft ein wenig, weil es eine Struktur auf Ihrem Code erzwingt und eine Reihenfolge für was sollte wo angezeigt werden. So können Sie sich in größeren Dateien etwas intuitiver orientieren.

Answer 7

Um die Lesbarkeit des Codes zu verbessern: Sie können den Regionsblock verwenden: https://msdn.microsoft.com/en-us/library/9a1ybwek.aspx. Um die Struktur und das Design Ihres Codes zu verbessern, konsultieren Sie einige Fachbücher.