Для начала мы обсудим, зачем вам вообще может понадобиться писать более читаемый, а не краткий код. Затем мы рассмотрим стратегии, как это делать в случае:
- Именования переменных, классов и функций
- Вспомогательных функций
- Комментариев к коду
- Перечислений/словарей/запечатанных классов и так далее
- Упорядочивания и именования пакетов
Зависит ли эффективность от меньшего количества нажатий на клавиши?
Вспоминаю, как, будучи джуном, я думал, что более эффективно использовать аббревиатуры имён для идентификаторов (по сути, любых конструкций в коде, которым мы, разработчики, можем давать имена).
Моя логика была проста: если у меня это занимает меньше времени, то так я быстрее справлюсь с работой.
Эта логика имела бы смысл, если бы были истинными следующие условия:
- Мне или кому-то другому никогда не придётся читать или исправлять то, что я написал в прошлом
- Я нечасто забываю при чтении функции, в чём смысл одной или нескольких переменных
- Мне время от времени не приходится писать действительно сложный и запутанный код
- Я могу переименовывать функции, классы или свойства внешних библиотек с непонятными или нелогичными названиями во что-то более разумное
Смысл в том, что
я очень редко бывал в ситуациях, когда краткость действительно экономила время. Более того, современные IDE имеют полезную функцию под названием «автодополнение кода», которая и так позволяет существенно меньше нажимать на клавиши.
У вас может быть другое мнение, и это абсолютно нормально! Можете взять из этой статьи только самое полезное для вас, а об остальном забыть.
