Нейминг базовых классов / WinForms, .Net Framework

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

Denis.,

В нашем стайлгайде так:

Код: c#

1.
2.
3.
4.
5.
6.
7.

public abstract class SomeAbstractClassBase : ISomeInterface
{
}

public class ConcreteSomeClass : SomeAbstractClassBase
{
}

в случае, если абстрактный базовый класс не является контрактом, а всего лишь базовой реализацией.

Если необходимо использовать абстрактный класс в качестве контракта, например, существуют методы, принимающие объекты наследников базового класса, или параметризация типом базового класса:

Код: c#

1.
2.
3.
4.
5.
6.
7.
8.
9.

public class SomeClient
{
    public void PutSomeClass(SomeAbstractClass instance);
}

public class SomeGenericHolder<TSomeClass> where TSomeClass : SomeAbstractClass
{
    // ...
}

тогда суффикс Base не используется.

...

Рейтинг:

0 / 0

19.07.2017, 08:27

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491300

Участник

Откуда: Новосибирск

Сообщения: 14 461

Рейтинг: 0 / 0

Denis.Как называете базовые абстрактные классы?По настроению. Главное, чтобы название отражало суть.

зы: "стайлгайды" детский сад.

...

Рейтинг:

0 / 0

19.07.2017, 08:41

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491304

skyANA

Участник

Откуда: Зеленоград

Сообщения: 22 795

Рейтинг: 0 / 0

Алексей КDenis.Как называете базовые абстрактные классы?По настроению. Главное, чтобы название отражало суть.

зы: "стайлгайды" детский сад.
Стайлгайды - это договоренность. А вот в детском саду обычно по настроению :)

...

Рейтинг:

0 / 0

19.07.2017, 08:44

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491334

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

Алексей КПо настроению. Главное, чтобы название отражало суть.

Из разряда:

— главное, чтобы было хорошо!
— каковы критерии «хорошо»?
— ээ....

— главное, чтобы отражало суть!
— каковы критерии того, что суть отражена?
— ээаэаээ...

— главное, чтобы код был качественный!
— каковы критерии качественного кода?
— нуу...

По настроению можно копать или не копать.

Алексей Кзы: "стайлгайды" детский сад.

Детский сад, это «по настроению». Смысла обсуждать и спорить на эту тему нет, потому что по-настроенщики могут быть только одиночки, и к командной разработке таких детишек не допускают.

...

Рейтинг:

0 / 0

19.07.2017, 09:34

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491337

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

skyANAСтайлгайды - это договоренность. А вот в детском саду обычно по настроению :)

Да вообще, Алексей удивляет.

...

Рейтинг:

0 / 0

19.07.2017, 09:35

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491413

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

hVosttв случае, если абстрактный базовый класс не является контрактом, а всего лишь базовой реализацией.

А если и то и то? Как же быть?

...

Рейтинг:

0 / 0

19.07.2017, 11:21

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491420

Участник

Откуда: Новосибирск

Сообщения: 14 461

Рейтинг: 0 / 0

hVostt— главное, чтобы отражало суть!
— каковы критерии того, что суть отражена?
— ээаэаээ...Всем читателям кода понятно из названия, для чего предназначен данный класс.
hVostt— главное, чтобы код был качественный!
— каковы критерии качественного кода?
— нуу... Программа делает то, что написано в техническом задании. Программа легко модифицируется, при необходимости.

...

Рейтинг:

0 / 0

19.07.2017, 11:33

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491423

Участник

Откуда: Новосибирск

Сообщения: 14 461

Рейтинг: 0 / 0

hVosttskyANAСтайлгайды - это договоренность. А вот в детском саду обычно по настроению :)

Да вообще, Алексей удивляет.Просто я работаю над долгоживущими проектами, в которых сменилось не одно поколение "стайлгайдов". :-)

...

Рейтинг:

0 / 0

19.07.2017, 11:35

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491447

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

Алексей КhVosttпропущено...

Да вообще, Алексей удивляет.Просто я работаю над долгоживущими проектами, в которых сменилось не одно поколение "стайлгайдов". :-)
Ну да, были времена, когда не было дженериков.

...

Рейтинг:

0 / 0

19.07.2017, 11:57

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491457

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

ЕвгенийВhVosttв случае, если абстрактный базовый класс не является контрактом, а всего лишь базовой реализацией.

А если и то и то? Как же быть?

Это плохо. Надо исправить когда время будет. Речь же идёт о нейминге нового класса, следовательно ты знаешь как ты его будешь использовать. Чаще всего контрактом является интерфейс, но иногда интерфейс лишнее звено и следует использовать базовый класс как контракт.

Такой нейминг нужен, чтобы было сразу понятно, как используется класс, это снимает много вопросов на взлёте.

...

Рейтинг:

0 / 0

19.07.2017, 12:02

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491465

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

Алексей КВсем читателям кода понятно из названия, для чего предназначен данный класс.

Т.е. ты даёшь почитать ВСЕМ свой код, чтобы решить, угадал ты с названием или нет?

У нас для этого по каждому проекту формируется словарь терминов.
Есть также общий словарь для паттернов и архитектурных единиц.
У каждой переиспользуемой библиотеки также есть свой словарь.

Нет такого, чтобы какой-нибудь Вася назвал класс как ему вздумается только потому, что он решил, что все его правильно поймут. Вот это детский сад.

Алексей КПрограмма делает то, что написано в техническом задании. Программа легко модифицируется, при необходимости.

Т.е. не важно какой там говнокод, если программа делает то, что написано в тех. задании?

Как же ты поймёшь, что программа будет легко модифицироваться при необходимости? Ждать, пока не произойдёт несколько модификаций, чтобы понять, хороший код или плохой?

У нас для этого используется оценка обязанностей и ответственности классов, оценка связанности и связности компонентов, количественная оценка зависимостей, объёма кода, количества свойств/методов, оценка по следованию принципам проектирования и разработки. Также учитываются перегибы (слепое и бездумное следование принципам), антипаттерны. Мы можем сказать почему данный код плохой и хороший и объяснить почему на понятном всем языке в общепринятой терминологии.

Вообще практикуешь code review? Занимался этим когда-нибудь?

...

Рейтинг:

0 / 0

19.07.2017, 12:12

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491483

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

Base есть, Abstract в топку.

Код: c#

1.
2.
3.
4.
5.
6.

System.Reflection.Assembly
                .GetAssembly(typeof(string))
                .GetTypes()
                .Where(x => x.IsAbstract && x.IsPublic && !x.IsSealed && !x.IsInterface)
                .Select(x => x.Name)
                .OrderBy(x => x);

msAccessRule Aes Array Assembly AsymmetricAlgorithm AsymmetricKeyExchangeDeformatter AsymmetricKeyExchangeFormatter AsymmetricSignatureDeformatter AsymmetricSignatureFormatter Attribute AuditRule AuthorizationRule BaseChannelObjectWithProperties BaseChannelSinkWithProperties BaseChannelWithProperties Binder Calendar CodeAccessPermission CodeAccessSecurityAttribute CodeGroup CollectionBase CommonAcl CommonObjectSecurity Comparer`1 ConstructorInfo ContextBoundObject CriticalFinalizerObject CriticalHandle CriticalHandleMinusOneIsInvalid CriticalHandleZeroOrMinusOneIsInvalid CustomConstantAttribute Decoder DecoderFallback DecoderFallbackBuffer Delegate DeriveBytes DES DictionaryBase DirectoryObjectSecurity DSA EastAsianLunisolarCalendar Encoder EncoderFallback EncoderFallbackBuffer Encoding EncodingProvider Enum EqualityComparer`1 EventInfo EvidenceBase FieldInfo FileSystemInfo FileSystemSecurity FormattableString Formatter GenericAce GenericAcl GenericSecurityDescriptor HashAlgorithm HMAC IdentityReference IsolatedStorage IsolatedStoragePermission IsolatedStoragePermissionAttribute KeyedCollection`2 KeyedHashAlgorithm KnownAce MarshalByRefObject MaskGenerationMethod MD5 MemberInfo MethodBase MethodInfo Module MulticastDelegate NativeObjectSecurity ObjectAccessRule ObjectAuditRule ObjectSecurity ObjectSecurity`1 OrderablePartitioner`1 Partitioner`1 PropertyInfo QualifiedAce RandomNumberGenerator RC2 ReadOnlyCollectionBase RealProxy ReflectionContext Rijndael RIPEMD160 RSA SafeBuffer SafeHandle SafeHandleMinusOneIsInvalid SafeHandleZeroOrMinusOneIsInvalid SecurityAttribute SecurityState SerializationBinder SHA1 SHA256 SHA384 SHA512 Stream StringComparer SymmetricAlgorithm TaskScheduler TextReader TextWriter TimeZone TripleDES Type TypeInfo ValueType WaitHandle

...

Рейтинг:

0 / 0

19.07.2017, 12:23

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491484

Участник

Откуда: Новосибирск

Сообщения: 14 461

Рейтинг: 0 / 0

hVostt... в общепринятой терминологии.Ну говорю же - детский сад. Нет никакой "общепринятой терминологии". Есть стандарты имеющие конкретные наименования: ГОСТ, СНИП, ANSI, ISO и т. п. Всё остальное - чьё-то субъективное мнение. :-)

...

Рейтинг:

0 / 0

19.07.2017, 12:23

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491527

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

Алексей КhVostt... в общепринятой терминологии.Ну говорю же - детский сад. Нет никакой "общепринятой терминологии". Есть стандарты имеющие конкретные наименования: ГОСТ, СНИП, ANSI, ISO и т. п. Всё остальное - чьё-то субъективное мнение. :-)

ГОСТ нам спустили с неба в виде скрижалей?
ISO переведено с найденных манускриптов племени Майя?
ANSI это научная аксиома.
СНИП от инопланетян.

А всё остальное.. ну да, мы поняли
Уведите пациента в палату №6

...

Рейтинг:

0 / 0

19.07.2017, 13:02

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491614

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

hVostt
ГОСТ нам спустили с неба в виде скрижалей?
ISO переведено с найденных манускриптов племени Майя?
ANSI это научная аксиома.
СНИП от инопланетян.

Это общепринятые системы рекомендованные/навязанные всем заинтересованным.
Сфера их применения выходит далеко за границы отдельно взятой небольшой шаражки.

...

Рейтинг:

0 / 0

19.07.2017, 14:44

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491690

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

ЕвгенийВЭто общепринятые системы рекомендованные/навязанные всем заинтересованным.
Сфера их применения выходит далеко за границы отдельно взятой небольшой шаражки.

Т.е. всеми приказами, регламентами и распоряжениями отдельно взятой шаражки можно попу подтереть?
Это ведь не ГОСТ и не ISO какое-то, так?

Приходишь однажды в такую контору, и тебе говорят, — ты это.. код пиши по настроению, ясно тебе? Но чтобы название классов отражало суть и всем было всё понятно, окэй? Ну и чтобы модифировать было легко. Вот как-то так. Потом проходит время и какой-нибудь Алексей К смотри в код, и говорит что ему нехрена не понятно, и что вот эти названия совсем не отражают суть, потому что твои зелёные фломастеры ему кажутся синими. И ему совсем не кажется, что твой код легко модифицировать.

И как он это объясняет? А вот так: я художник, я так вижу.

В общем, детский сад, как он есть. Во всей красе. Ага.

...

Рейтинг:

0 / 0

19.07.2017, 15:39

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491781

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

hVostt,
Нафига придумывать свои "стайлгайде", отличные от общепринятых изначально, идущих от МС?
Любой .NET программист привык к ним.
Нафига вкрячивать слово Abstract? Ну префикс "A" еще куда не шло.
Как бы ты назвал тот же Stream или TextReader?
А серьезная бизнес-модель и иерархия наследования не предок-потомок? Типа

Код: c#

1.
2.
3.
4.

 public abstract class A { }
        public class B :A { }
        public abstract class C :B { }
        public sealed class D :C { }

или сложнее?

...

Рейтинг:

0 / 0

19.07.2017, 17:56

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491792

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

ЕвгенийВНафига придумывать свои "стайлгайде", отличные от общепринятых изначально, идущих от МС?

Где я такое говорил? Они вообще-то на них и базируются.

ЕвгенийВЛюбой .NET программист привык к ним.

Не любой, переучки (из делфи, java, C/C++...) ещё какое-то время создают локальный пздц в коде, пока не идут на поправку :)

ЕвгенийВНафига вкрячивать слово Abstract? Ну префикс "A" еще куда не шло.

Никто не вкорячивает слово Abstract, речь шла только о суффиксе Base. Если ты про пример, где класс называется SomeAbstract, это просто пример наименования класса, но я нигде не говорил, что это приставка какая-то.

ЕвгенийВКак бы ты назвал тот же Stream или TextReader?

Так бы и назвал.
Хотя касательно Stream это величайшей фейл Microsoft. Нужен был интерфейс IStream, а не базовый класс. Это просто мега-отвратительное решение. А ещё лучше IReadStream и IWriteStrem, но уже поздно.

ЕвгенийВили сложнее?

В общем, не выдумывай. Я русскими словами описал наш стайл по поводу наименования базовых классов. Если класс выступает контрактом, никаких префиксов-суффиксов не предусмотрено. Если класс выступает только как базовая реализация и не фигурирует в контрактах, то используется суффикс Base. Смысл и польза от этого — достаточно очевидные.

Как говорится, есть две самые страшные проблемы в программировании: придумывать имена переменных и инвалидировать кеш

...

Рейтинг:

0 / 0

19.07.2017, 18:08

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491808

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

hVostt
Так бы и назвал.
Хотя касательно Stream это величайшей фейл Microsoft. Нужен был интерфейс IStream, а не базовый класс. Это просто мега-отвратительное решение. А ещё лучше IReadStream и IWriteStrem, но уже поздно.

Что тут то не так? Чем плох старина Stream?

...

Рейтинг:

0 / 0

19.07.2017, 18:46

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491814

Доступно с 4.5
Доступно с 1.1

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

...

Рейтинг:

0 / 0

19.07.2017, 18:57

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491820

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

ЕвгенийВЧто тут то не так? Чем плох старина Stream?

Тем, что требуется вынужденно наследоваться от класса, ты не можешь просто взять и реализовать интерфейс IStream, тебе придётся как минимум реализовать лишний адаптер.

Чаще всего потоки используются только на чтение или только на запись, а клиентам теперь приходится лишний раз проверять Stream, умеет ли он то, что от него требуется (CanRead, CanWrite, CanSeek), вместо того, чтобы выяснить это ещё на стадии компиляции (IReadStream / IWriteStream / ISeekStream).

...

Рейтинг:

0 / 0

19.07.2017, 19:09

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491822

Участник

Сообщения: 18 899

Рейтинг: 0 / 0

ЕвгенийВ Доступно с 4.5
Доступно с 1.1

Я надеялся, что хоть в новом стандарте поправят... ЭЭээх.

...

Рейтинг:

0 / 0

19.07.2017, 19:10

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491827

Участник

Откуда: Москва

Сообщения: 3 430

Рейтинг: 0 / 0

hVostt,
То, что нечто реализует например IReadStream - не означает, что в рантайме сможем читать.
Да и при введении тех же тасков, потребовалось переписать только 1 класс! А так, был бы IReadStream, от него отнаследовали бы IReadStreamAsync, и пришлось реализовывать всех потомком IReadStream, добавив им асинхронности.

...

Рейтинг:

0 / 0

19.07.2017, 19:26

| Ответить | Цитировать | Написать

Нейминг базовых классов

#39491843