Stworzyłem ObjectParser
klasę, która analizuje dane w silnie typowane obiekty, używając IObjectParserDataSource
jako źródła danych (dane mogą być plikiem Excel, plikiem tekstowym, tablicą, ciągiem zapytania itp.).
Przykłady moich wdrożeń IObjectParserDataSource
to:
TextFileObjectParserDataSource
ExcelFileObjectParserDataSource
Te nazwy klas są dla mnie naprawdę długie i skomplikowane.
Mógłbym je wymienić:
TextFileDataSource
ExcelFileDataSource
Wprowadza to jednak pewien poziom niejednoznaczności i IObjectParserDataSource
na pierwszy rzut oka nie są one tak wyraźnie związane . Staje się to ważne, ponieważ zdefiniowanie tych źródeł danych nastąpi w kodzie klienta i chcę zminimalizować potencjalne zamieszanie i niepewność.
Jak nazwałbyś te klasy w takim scenariuszu?
c#
.net
naming
coding-standards
Dave New
źródło
źródło
ExcelFileOPDS
,TextFileOPDS
. Oszczędza to trochę pisania i miejsca na ekranie, ale jest nieprzejrzyste dla kogoś, kto nie zna kodu.Odpowiedzi:
Generalnie staram się obejść ten problem, umieszczając wszystkie podobne obiekty w jednej przestrzeni nazw i upraszczając ich nazwy (jeśli mogę to zrobić).
Na przykład miałby
Lub, jeśli kolekcja obiektów współpracujących z / servicing stanie
ObjectParser
się wystarczająco duża, stworzę osobne drzewo folderów lub projekt poświęcony tylko ObjectParser:W obrębie każdego pliku instrukcje importu i kontekst kodu zwykle jasno wskazują, że
TextFileSource
jest toObjectParser
źródło danych. Jeśli w tym samym fragmencie kodu znajduje się wiele klas o podobnych nazwach, możesz się do nich odwołać poTextFileSource
pełnej nazwie:Zwykle zdarza się to bardzo rzadko i nie mam nic przeciwko wpisywaniu kilku dodatkowych słów.
źródło