Хороший нейминг Нейминг безусловно является очень важным моме | Veras IT

Хороший нейминг

Нейминг безусловно является очень важным моментом в коде. Плохие имена переменных, функций и т.д. могут загадить даже самый чистый код и отнять у будущих разработчиков много времени на понимание кода. Так и наоборот продуманные имена могут спасти говнокод и сделать его более читаемым, при том что много времени это, как правило, не отнимает.
Каких же правил придерживаться чтоб наши имена помогали нам читать код, а не наоборот?

1. Легко произносимые и легкие для поиска. Имена не должны быть аббревиатурами (только если часть имени ей является), сокращениями. Переменная должна легко читаться как наши обычные разговорные слова.

2. Избегать однобуквенных имен. Такие имена можно использовать только в одно-двух строчных функциях, когда , например, переменная просто прокидывается куда-то дальше в другую функцию как аргумент и нет нужны давать осмысленное имя. Но как только функция начинает расти , однобуквенные переменные стоит сразу переименовывать

3. Возвращаться к переименованию. Тот же WebStorm позволяет довольно безболезненно переименовывать что либо в сразу в нескольких местах и не сломать код. Поэтому не стоит бояться возвращаться к переименованию , ведь у нас программистов ничего *ничего не получается с первого раза*.

4. Не боятся длинных имен. Конечно короткое и просто имя лучше сложного и длинного, но если короткое имя дать не получается и требуются некоторые уточнения - смело пишите их. Но тут тонкая грань, т.к. важно не дезинформировать (в первую очередь самого себя) нашего будущего читателя кода.

Это лишь некоторые из возможных советов по именованию. Самое главное - не делать это на автомате.