06.08.2022

5 привычек, мешающих писать хороший код

Сергей Немчинский
5 минут чтения
  • Использовать непонятные названия переменных и функций

Чаще всего именно новички не видят необходимости заморачиваться над наименованиями — «Зачем, ведь я и так все понимаю и помню?». И как долго вы будете все это держать в голове? А главное, зачем? Код должен быть простым и понятным всем программистам, которые будут работать с ним позже. Первый шаг к этому – давать осмысленные имена переменным, функциям и классам.

  • Несоблюдение Code style компании

«Я так привык, мне так удобнее» — привычка писать код как удобно вам, но не как заведено в компании, может снизить эффективность работы всей команды. При переходе в новую компанию, правила оформления кода в конкретном проекте могут отличаться от привычного вам. Стандарт оформления позволяет унифицировать код всех разработчиков команды, сделать его более простым к восприятию.

  • Не писать документацию

Возиться с документацией не любит большинство программистов. Частое оправдание – код и есть лучшая документация. Но если к коду нужно вернуться через несколько лет и/или если разработчик, работавший с кодом не доступен, начинаются проблемы. Новые программисты могут потратить лишние дни, а то и недели, чтобы разобраться, что, как и зачем сделано.

  • Быстрые решения

Услышать задачу и сразу побежать делать, не разобравшись в нюансах/не прочитав полностью требования. Иногда (всегда) нужно узнать, какую конкретно проблему хочет решить клиент, часто есть более простые решения задачи.

Быстрые решения как правило более громоздкие, менее эффективные и часто ведут к дальнейшим исправлениям. Основная работа программиста – не настрочить как можно больше строк, а сделать так, чтобы код работал максимально эффективно. А для этого нужно сначала продумать все в голове и только потом писать.

  • Делать больше, чем нужно

Некоторые разработчики не только реализовывают поставленную задачу, но и «на всякий случай» добавляют что-то сверху. Обычно программист дописывает дополнительный кусок кода из предположения, что он может понадобиться в будущем. «Оверинжиниринг» — вроде бы и не сильно страшная привычка, но отнимает время (а значит и деньги клиента) и ведет к ненужному усложнению кода. Кроме того, добавленный кусок кода может так никогда и не понадобиться, соответственно это нецелесообразная трата времени. 

  • Работать без выходных и отдыха

Вы можете работать 7 дней в неделю по 20 часов в сутки, но только стоит ли оно того? Как долго вы сможете поддерживать высокую эффективность в таком темпе? 6-8 рабочих часов в сутки с обязательными перерывами дадут вам больше результатов. А еще не забывайте про спорт – когда тело в тонусе и мозг работает лучше. Но это уже из очевидного.