Konwencja nazewnictwa klas C: Czy jest to klasa BaseClass lub klasa klasy lub Klasa abstrakcyjna

Question

Jakie jest zalecane podejście do nazywania klas bazowych? Czy jest to przedrostek nazwy typu z "Podstawa" lub "Streszczenie", czy możemy po prostu przyrostek z "Base"?

rozważyć następujące:

typ: ViewModel np MainViewModel, ReportViewModel

klasy skład: BaseViewModel lub ViewModelBase lub AbstractViewModel

również następujące:

typ: Product np VirtualProduct, ExpiringProduct

klasa bazowa: BaseProduct lub ProductBase lub AbstractProduct

Co myślisz jest bardziej standard?

class Entity : EntityBase 
{ 
} 

lub

class Entity : BaseEntity 
{ 
} 

Answer 1

W ramce znajdują się przykłady z sufiksem Podstawowy, np. System.Configuration.Provider.ProviderBase, System.Web.SessionState.SessionStateStoreProviderBase.

Jednak nie wszystkie abstrakcyjne klasy bazowe w Ramach są zgodne z tą konwencją (np. System.Data.Common.DbParameter, System.Data.Common.DbCommand).

Osobiście unikam używania przyrostka , chyba że Chciałem podkreślić fakt, że jest to klasa abstrakcyjna i czułem, że inaczej użytkownicy klasy mogą oczekiwać, że nazwa wskaże konkretną implementację.

Answer 2

Żaden z powyższych. Zastanów się, jaki cel zapewnia twoja klasa bazowa; nazwij to. Na przykład podstawową klasą samochodów i rowerów może być pojazd.

Jeśli tworzysz klasy bazowe tylko po to, aby mieć klasę bazową jednej klasy i bez żadnego celu ani przyczyny, prawdopodobnie robisz coś złego.

Answer 3

Używamy BaseEntity, ale myślę, że to twoje własne preferencje. Często widzę tego drugiego.

Po prostu zachowaj spójność w swoim kontekście, czy to w projekcie, w przestrzeni nazw, czy w miarę możliwości w zespole. Różne konwencje są gorsze niż zła konwencja IMHO.

Answer 4

Osobiście nie polecam dodawania bazy słów w ogóle. Nigdy nie wiesz, kiedy będziesz musiał zmienić kod i nie będzie to już obiekt podstawowy. Biorąc to pod uwagę, robiliśmy to już w przeszłości, na początku dodaliśmy słowo Base. Wydaje się, że płynie lepiej.

Answer 5

BaseEntity wygląda bardzo podobnie do wielbłąda - strName, bseEntity. Wybrałbym EntityBase, ponieważ najpierw definiuje temat, co pomoże ci szybciej zidentyfikować jego funkcję.

Answer 6

Jeśli mówimy o klasach wirtualnych bazowych, standard Microsoftu jest ClassnameBase (jak CollectionBase.)

Answer 7

Zawsze myśleć o alphabetizing kiedy wymienić rzeczy. Naprawdę nie lubię patrzeć na serwer SQL i każda procedura przechowywana nazywa się usp [coś]. W tym samym kierunku nie nadużywaj Get and Set jako wiodących nazw funkcji. Zamiast GetItems lub PlaceOrder pomyśl o nazwaniu ich jako ItemsGet lub OrderPlace.

Ogólnie rzecz biorąc, ClassnameBase/EntityBase będzie lepszym wyborem.

Answer 8

Myślę, że to kwestia wyboru. Powiedziałbym, że jeśli tworzysz wiele klas bazowych, to być może lepiej jest iść z BaseClassname zawsze, ponieważ w ten sposób ZAWSZE możesz dowiedzieć się, jakie klasy bazowe możesz zacząć używać po prostu wpisując Bazę i otrzymując resztę pomocy od Intellisense. Co jeśli masz 20 klas bazowych i dodajesz Base jako sufiks, a zapomniałeś jaka była nazwa klasy bazowej? Czy chcesz najpierw utworzyć diagram klas z VS i dowiedzieć się, jakie klasy bazowe są dostępne? Dobrze jest nazwać je ClassBase, gdy jest to tylko jedna lub dwie klasy.

To samo dotyczy decyzji między GetItems i funkcją ItemsGet. Powiedziałbym ze względu na czytelność - idź na GetItems. Postępuj zgodnie z konwencjami :)