Примечания к чистому коду: выбор эффективных имен
Написание чистого кода — это не только форма искусства, но и важный навык, необходимый для того, чтобы помочь продуктам пережить новых инженеров, кодовый долг и постоянно меняющийся мир технологий. Без чистого, элегантного и осмысленного кода становится трудно делиться работой от одного человека к другому. Чистый код должен быть эффективным, минимальным и рассказывать убедительную историю о том, зачем он нужен и чем он полезен.
Обсуждение написания такого кода начинается с эффективных соглашений об именах. Вот некоторые из моих замечаний по выбору осмысленных имен.
- Имена с намерением: они должны раскрывать, почему они существуют, что они делают и как они будут использоваться. В битве между неявными и явными именами явные побеждают.
- Избегайте дезинформации. Будьте точны в своем названии, потому что любые ложные идеи в вашем коде могут запутать другого разработчика. Последовательность является ключевым моментом, поскольку она позволяет информации и истории плавно передаваться от одного человека к другому.
- Делайте значимые различия. Программирование для удовлетворения вашего компилятора только причинит вам боль позже. Если вам необходимо переименовать переменную/функцию, различайте имена так, чтобы они оставались понятными, не было потери информации, и человек, читающий ваш код, все еще мог его прочитать.
- Используйте произносимые имена. Представьте, что вы читаете вслух название своей переменной/функции своему начальнику. Попросите кого-нибудь еще просмотреть ваш код, чтобы убедиться, что он не звучит глупо.
- Имена с возможностью поиска.Используйте имеющиеся у вас инструменты в своих интересах. Современные IDE имеют функциональные возможности, которые могут как сильно помочь, так и сильно помешать. Ознакомьтесь со своим инструментом и используйте его для себя, а не против себя.
- Интерфейс и реализации. Помните о том, что вы хотите, чтобы ваш пользователь знал. Никогда не раскрывайте всю руку.
- Имена классов и методов. Классы и объекты должны иметь имена с существительными, методы с глаголами. Классы — это вещи, а методы — это действия, выполняемые в вашей программе.
- Выбирайте имена со смыслом.Если вы будете мило выглядеть в коде, это будет пустой тратой времени. Это означает отсутствие каламбуров или названий, характерных для конкретной культуры. Это также означает использование технических имен там, где это уместно, и использование имен для конкретных задач, когда это не так. Имена должны иметь осмысленный контекст. Код, который вы пишете, представляет собой историю и должен иметь четкий контекст.
Ресурсы:
Если у вас есть дополнительные советы или отзывы, напишите мне: Charles Njoroge
