Welche Namenskonvention für C # -Dateien, die mehrere Klassen enthalten?

In C # -Projekten gruppieren wir häufig kleine und eng verwandte Klassen in derselben .csDatei. Diese Vorgehensweise verringert die Reibung beim Umgang mit einer Vielzahl von Dateien, die nahezu keinen eigentlichen Code enthalten. Gibt es jedoch eine bewährte Methode, um die Datei zu benennen , die mehrere Klassen enthält?

Mein Rat: Vermeiden Sie Dateien mit mehreren Klassen und Namensdateien == Klassen, auch wenn Sie meinen, dass es zu viele Dateien gibt. Versuchen Sie, sie in Ordnern zu organisieren. In ganz besonderen Fällen haben Sie möglicherweise verschachtelte Klassen. In diesem Fall ist es sinnvoll, die Hauptklasse und eine verschachtelte Klasse in verschiedene Dateien mit einer Teilklasse zu unterteilen. In diesem Fall verwende ich folgende Namenskonvention.

MyEnumerable.cs
MyEnumerable.MyEnumerator.cs

Wahrscheinlich können Sie in Ihrem Fall auch mehrteilige Dateinamen verwenden.

Vermeiden Sie es, mehr als eine Klasse in einer Datei zu haben, mindestens jedoch eine öffentliche Klasse. Wählen Sie beim Benennen von Klassendateien mit mehreren Klassen einen beschreibenden Dateinamen.

Referenzen:

• http://weblogs.asp.net/lhunt/pages/CSharp-Coding-Standards-document.aspx . (2.2 Verwendung und Syntax von Namen)
• http://blogs.msdn.com/b/brada/archive/2005/01/26/361363.aspx (2.8 Dateiorganisation)

Wenn Sie sich die Frage stellen, wie solche Dateien benannt werden sollen, haben Sie bereits einen für Sie problematischen Codegeruch identifiziert, der sich nicht so leicht beheben lässt.

Unabhängig von den Überlegungen werden Sie feststellen, dass es schwierig ist, sinnvolle Namen zu wählen, wenn Sie mehr als eine Klasse in einer Datei haben passt nicht ganz zu dem Gruppennamen, den Sie einer Gruppe von Klassen zuweisen.

Die kurze Antwort lautet daher, dass es keinen anerkannten oder etablierten Standard für die Benennung dieser Art von Dateien gibt. Mein Vorschlag wäre, sich mit Ihrem Team zusammenzusetzen und sich um die Organisation Ihres Codes zu kümmern und ein wenig umzugestalten, um die Dinge ein wenig aufzuräumen.

Um den Einstieg zu erleichtern, würde ich jedoch fragen, ob die zusätzlichen Klassen verschachtelt oder unabhängig sind. Wenn sie unabhängig sind, können diese Klassen einfacher in ihre eigenen Dateien aufgeteilt werden, wobei jede Datei nach der darin enthaltenen einzelnen Klasse benannt wird. Wenn verschachtelt, müssen möglicherweise weitere Entscheidungen darüber getroffen werden, wie solche Klassen organisiert werden sollen. Die verschachtelten Klassen müssen jedoch möglicherweise nicht sofort entfernt werden, und die Dateien werden daher nach der äußersten Klasse benannt. Was die Verschachtelung betrifft, gibt es viele Argumente dagegen und einige vernünftige, die unter bestimmten Umständen für die Verschachtelung sprechen. Mein Rat wäre, zu fragen, ob ein vernünftiger Namespace und die Schaffung einer besser organisierten Quellcodestruktur eine bessere Lösung darstellen das Problem.

In der Realität werden Sie jedoch feststellen, dass Sie sich am Ende der Lebensdauer Ihres Projekts gewünscht haben, dass Ihre Dateien nur eine einzige Klasse und eine passende Verzeichnis- / Namespace-Struktur enthalten.

Prost,

Früher war es alles, um mehrere Klassen in einer Datei zu haben, aber seitdem ich als Programmierer gearbeitet habe (anstatt alleine zu sein), habe ich festgestellt, dass es ein Wartungs-Albtraum mit vielen Klassen in einer einzigen Datei sein kann. Zugegebenermaßen kann Visual Studio durch die Verwendung von F12 eine Menge helfen (siehe Definition).

Ich habe damit begonnen, eine Namenskonvention wie folgt zu verwenden: namespace.klassenname.cs Auf diese Weise weiß ich genau, was sich in jeder Datei befindet, und es wird auch eine Art Gesamtkontext der Datei bereitgestellt. Wenn sich die Klasse im Standardnamespace befindet, verwende ich einfach die Datei classname.cs (ähnlich wie in Java).