C# Convención de nomenclatura de clase: ¿es BaseClass o ClassBase o AbstractClass

Question

¿Cuál es el enfoque recomendado para nombrar las clases base? ¿Está prefijando el nombre de tipo con "Base" o "Resumen" o simplemente lo sumaríamos con "Base"?

considerar lo siguiente:

tipo: ViewModel por ejemplo MainViewModel, ReportViewModel

clase base: BaseViewModel o ViewModelBase o AbstractViewModel

Considera también:

tipo: Product por ejemplo VirtualProduct, ExpiringProduct

clase base: BaseProduct o ProductBase o AbstractProduct

¿Cuál cree que es más estándar?

class Entity : EntityBase 
{ 
} 

o

class Entity : BaseEntity 
{ 
} 

Answer 1

Existen ejemplos en el Framework con el sufijo Base, p. System.Configuration.Provider.ProviderBase, System.Web.SessionState.SessionStateStoreProviderBase.

Pero de ninguna manera todas las clases base abstractas en el Framework siguen esta convención (por ejemplo, System.Data.Common.DbParameter, System.Data.Common.DbCommand).

Personalmente, evitaría usar el sufijo , a menos que quisiera enfatizar el hecho de que es una clase abstracta y sentí que los usuarios de la clase podrían esperar que el nombre indique una implementación concreta.

Answer 2

Ninguna de las anteriores. Considere qué propósito proporciona su clase base; Nómbralo. Por ejemplo, la clase base de automóvil y bicicleta podría ser un vehículo.

Si está creando clases base solo para tener una clase base de una clase, y sin otro propósito o motivo que no sea eso, probablemente esté haciendo algo mal.

Answer 3

Utilizamos BaseEntity, pero creo que es su preferencia. Con frecuencia veo el otro.

Simplemente sea coherente dentro de su contexto, ya sea su proyecto, el espacio de nombres o, si es posible, su equipo. Diferentes convenciones son peores que una mala convención en mi humilde opinión.

Answer 4

Personalmente, recomendaría no agregar la palabra base en absoluto. Nunca se sabe cuándo tendrá que cambiar el código y ya no será el objeto base. Una vez dicho esto, hemos hecho esto en el pasado, hemos prefijado la palabra Base en el frente. Parece fluir mejor.

Answer 5

BaseEntity se parece mucho a camel case - strName, bseEntity. Me decantaría por EntityBase ya que primero define el tema, lo que te ayudará a identificar su función más rápido.

Answer 6

Si estás hablando de clases base virtuales, las normas de Microsoft es ClassnameBase (como CollectionBase.)

Answer 7

Pensar siempre alfabéticamente al dar nombre a las cosas. Realmente no me gusta mirar un servidor SQL y cada procedimiento almacenado se llama usp [algo]. En la misma línea, no use en exceso Get y Set como nombres principales para una función. En lugar de GetItems o PlaceOrder, piense en nombrarlos como ItemsGet o OrderPlace.

Por lo tanto, en general, ClassnameBase/EntityBase sería una mejor opción.

Answer 8

Creo que es una cuestión de elección. Yo diría que si estás creando muchas clases base, entonces quizás sea mejor ir con BaseClassname siempre, porque de esa manera SIEMPRE puedes averiguar qué clases base puedes usar simplemente escribiendo Base y obteniendo el resto de la ayuda de Intellisense. ¿Qué pasaría si tuviera 20 clases base y agregara Base como sufijo y olvidara cuál era el nombre de la clase base? ¿Desea crear primero un diagrama de clase de VS y descubrir qué clases base están disponibles? Está bien nombrarlos ClassBase cuando se trata de una o dos clases.

Igual va para la decisión entre la función GetItems y ItemsGet. Yo diría que al menos por legibilidad, ve por GetItems. Siga las convenciones :)