Best practices в именовании классов, методов и переменных?

Question

[Nikolino]

При написании кода хочется называть классы, методы и переменные максимально кратко, но в то же время понятно. Часто называю классы так: ImageHandler, TextHandler, TagsHandler и т.д., и когда классов становится больше, то по неймингу уже непонятно что они делают.

Так как самые широкие возможности ООП, пожалуй, в Java, решил посмотреть как там. А там очень весело с неймингом, пример из Spring:

- SimpleBeanFactoryAwareAspectInstanceFactory

- AbstractInterceptorDrivenBeanDefinitionDecorator

- AbstractInterruptibleBatchPreparedStatementSetter

- SimpleRemoteStatelessSessionProxyFactoryBean

- TransactionAwarePersistenceManagerFactoryProxy

Есть даже сервис шутошный: https://projects.haykranen.nl/java/

В Symfony тоже есть подобное: \Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToLocalizedStringTransformer

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

Вопросы:
How much is too much?
В каком случае лучше использовать короткий нейминг, в каком длинный? Есть ли зависимость между размером проекта и длиной имён?
Может есть какой-то сервис/рейтинг популярных слов (прилагательных, существительных) для нейминга, чтобы пополнить словарный запас?

Comments

[Александр]

Читайте Чистый код Мартина и php-fig.org

Answer 1

[samizdam]

Ответы:
> How much is too much?
Столько сколько достаточно, чтобы из имени класса понять его ответственность.

> В каком случае лучше использовать короткий нейминг, в каком длинный?
Дело вкуса. Чувство вкуса приходит с практикой. Практикуйте!

> Есть ли зависимость между размером проекта и длиной имён?
Нет.

> Может есть какой-то сервис/рейтинг популярных слов (прилагательных, существительных) для нейминга, чтобы пополнить словарный запас?
Учите английский, используйте переводчики. Чем более метко вы сможете транслировать свои мысли в код, тем понятнее он будет. При условии, что мысли правильные и понятные =)

Answer 2

[Dmitry]

Может есть какой-то сервис/рейтинг популярных слов (прилагательных, существительных) для нейминга, чтобы пополнить словарный запас?

source-code-wordle.de
https://onym.co/

Answer 3

[morricone85]

Часто называю классы так: ImageHandler, TextHandler, TagsHandler и т.д., и когда классов становится больше, то по неймингу уже непонятно что они делают.

а неймспейсы зачем?

Comments

[Nikolino]

Давайте на примере, вот есть Symfony класс:
\Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToLocalizedStringTransformer

В неймспейсе есть слово "Transformer", но в названии класса тоже есть "Transformer", вы считаете это избыточным?

То есть так было бы лучше?
\Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToLocalizedString

Такой вариант не очень подходит хотя бы по причине того, что когда в IDE мы импортируем класс, то его неймспейс прописывается в блоке use, который обычно "схлопывается" самой IDE, чтобы не мешал. И чтобы посмотреть, что же такое этот "DateTimeToLocalizedString", нам нужно раскрыть этот блок с use неймспейсами, а это неудобно.

[morricone85]

\Symfony\Component\Form\Extension\Core\DataTransformer - путь к файлу DateTimeToLocalizedStringTransformer, который соответствует папкам в файловой системе.

а, вот класс, DateTimeToLocalizedStringTransformer, так назван, потому, что точно описывает свою суть + в той папке, есть классы с похожими названиями например:

DateTimeToArrayTransformer.php, DateTimeToStringTransformer.php и т.д.

То есть, в папке есть классы с подобным функционалом, поэтому и названия такие.