C# Klassenbenennungskonvention: Ist es BaseClass oder ClassBase oder AbstractClass

Question

Was ist der empfohlene Ansatz zum Benennen von Basisklassen? Setzt es den Typnamen mit "Base" oder "Abstract" voran oder würden wir es einfach mit "Base" ergänzen?

sich das folgende:

Typ: ViewModel z.B. MainViewModel, ReportViewModel

Basisklasse: BaseViewModel oder ViewModelBase oder AbstractViewModel

Beachten Sie auch:

Typ: Product z.B. VirtualProduct, ExpiringProduct

Basisklasse: BaseProduct oder ProductBase oder AbstractProduct

die Sie denken Sie mehr Standard ist?

class Entity : EntityBase 
{ 
} 

oder

class Entity : BaseEntity 
{ 
} 

Answer 1

Es gibt Beispiele im Framework mit dem Suffix Base, z. System.Configuration.Provider.ProviderBase, System.Web.SessionState.SessionStateStoreProviderBase.

Aber keineswegs alle abstrakten Basisklassen im Framework folgen dieser Konvention (z. B. System.Data.Common.DbParameter, System.Data.Common.DbCommand).

Persönlich würde ich zu vermeiden, das Suffix mit es sei denn, ich die Tatsache betonen wollte, dass es sich um eine abstrakte Klasse ist und das Gefühl, dass sonst Benutzer der Klasse könnte der Name eine konkrete Umsetzung, um anzuzeigen, zu erwarten.

Answer 2

Keine der oben genannten. Überlegen Sie, welchen Zweck Ihre Basisklasse erfüllt. Nenne es so. Zum Beispiel könnte die Basisklasse von Automobil und Fahrrad Fahrzeug sein.

Wenn Sie Basisklassen erstellen, nur um eine Basisklasse einer Klasse zu haben, und ohne einen anderen Grund oder Grund als das, machen Sie wahrscheinlich etwas falsch.

Answer 3

Wir verwenden BaseEntity, aber ich denke es ist Ihre eigene Präferenz. Ich sehe oft den anderen.

Nur in Ihrem Kontext konsistent sein, sei es Ihr Projekt, Namespace oder wenn möglich, Ihr Team. Unterschiedliche Konventionen sind schlimmer als eine schlechte Konvention IMHO.

Answer 4

Persönlich würde ich überhaupt empfehlen, die Wortbasis überhaupt hinzuzufügen. Sie wissen nie, wann Sie den Code ändern müssen und es wird nicht mehr das Basisobjekt sein. Nachdem wir dies in der Vergangenheit getan haben, haben wir das Wort Base an der Front vorausgesetzt. Es scheint besser zu fließen.

Answer 5

BaseEntity sieht ähnlich aus wie camel case - strName, bseEntity. Ich würde für EntityBase gehen, da es das Thema zuerst definiert, was Ihnen helfen wird, seine Funktion schneller zu identifizieren.

Answer 6

Wenn Sie sprechen über virtuelle Basisklassen, Standard von Microsoft ist ClassnameBase (wie Collection.)

Answer 7

Denken Sie immer an alphabetisiert, wenn Sie Sachen nennen. Ich mag es wirklich nicht, auf einen SQL Server zu schauen, und jede gespeicherte Prozedur heißt usp [irgendwas]. Verwenden Sie in dieser Hinsicht nicht Get und Set als führende Namen für eine Funktion. Denken Sie statt GetItems oder PlaceOrder daran, sie als ItemsGet oder OrderPlace zu benennen.

Also, im Allgemeinen wäre ClassnameBase/EntityBase eine bessere Wahl.

Answer 8

Ich denke, es ist eine Frage der Wahl. Ich würde sagen, wenn Sie viele Basisklassen erstellen, dann ist es vielleicht besser, mit BaseClassname immer zu gehen, denn auf diese Weise können Sie IMMER herausfinden, welche Basisklassen Sie verwenden können, indem Sie einfach Base eingeben und den Rest der Hilfe erhalten Intellisense. Was wäre, wenn Sie 20 Basisklassen hätten und Sie Base als Suffix hinzugefügt hätten und Sie vergessen hätten, wie die Basisklasse heißt? Möchten Sie zuerst ein Klassendiagramm aus VS erstellen und herausfinden, welche Basisklassen verfügbar sind? Es ist in Ordnung, sie ClassBase zu nennen, wenn es nur ein oder zwei Klassen ist.

Gleiches gilt für die Entscheidung zwischen GetItems und ItemsGet-Funktion. Ich würde zumindest aus Gründen der Lesbarkeit sagen - gehen Sie zu GetItems. Befolgen Sie die Konventionen :)