ТОП-10 признаков плохого кода: хардкод и спагетти-код в примерах на JavaScript



Книга ТОП-10 признаков плохого кода: хардкод и спагетти-код в примерах на JavaScript

Многие программисты не знают, что пишут плохой код.

Скорее всего, конкретно вы уже заходили на GitHub, сохранить свой код, посмотреть на чужой. А теперь посмотрите на собственные старые проекты, написанные годом ранее  —  вы удивитесь, насколько лучше стали ваши навыки с того момента.

Большинство младших программистов (и даже некоторые более опытные) не знают, как отличить хороший код от плохого. Когда программа заработает  —  они сразу идут дальше. К тому же, если они работают в одиночку, то никогда даже не узнают, что пишут плохой код.

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

В руководстве пойдет речь о некоторых признаках, выдающих плохие практики в разработке программного обеспечения. Давайте же разберемся!


1. Повсюду скопированный код

Подобное случается с каждым программистом, стоит только перестать стараться писать чистый код.

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

Конечно, ведь всегда проще скопировать-вставить, чем написать функцию. Но вопрос состоит в том, когда подобный метод применим, а когда  —  только навредит кодовой базе?

Каждый раз, когда блок кода пригодился вам дважды  —  пишите с ним функцию. Подобный подход характеризуется рядом существенных преимуществ:

  1. Экономия времени, ведь функции изначально предназначены для подобного, верно?
  2. Чистый, структурированный код, который легко понять.
  3. Потенциал повторного применения функции в других проектах.
  4. Легкость удаления мусорного кода.
  5. Удобство в отладке. 

2. Одинаковые функции, но разный интерфейс

Постоянство  —  качество хорошего программиста: старайтесь следовать шаблону, ведь вам придется написать еще очень много функций. 

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

Проверка заключается в том, что при совпадении входных данных с данными о пользователе булевы функции возвращают true, а при несовпадении  —  возвращают false.

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

Приведенный пример достаточно прост, но то же самое относится ко всем функциям и методам вашего проекта. Если вы пишите непоследовательный код, то знайте, что это не профессионально. Пожалуйста, убедитесь, что коллегам-разработчикам легко прочесть ваш код!


3. Хардкод

Все ненавидят жесткий кодинг, “хардкод”. Хорошо, что его появление легко заметить и предотвратить. Проанализируйте следующий фрагмент кода:

for(int i=0; i<50; i++){
//Do something
}

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

int n=50;

for(int i=0; i<n; i++){
//Do something
}

Динамические приложения всегда лучше статических. Когда нужно менять какую-либо часть статического решения, то приходится каждый раз обновлять приложение.

Большинство проектов подключаются к облачным сервисам. Если ваши проекты синхронизированы с какими-либо из них, то лучше сразу получать данные из облака согласно его стандарту.

int n = fethDataFromCloud();

for(int i=0; i<n; i++){
  ...
}

Некоторые программисты оставляют в кодовой базе хардкод на этапе тестирования, а потом ленятся исправить его на этапе производства из-за сроков и некоторых других причин. Но, пожалуйста, не поступайте так! В дальнейшем каждый экземпляр хардкода в проекте добавит вам еще больше давления и задач.


4. Слишком длинные и сложные условия

Определение достаточно абстрактное, так что же имеется в виду? 
Во-первых, не стоит писать “спагетти-код”  —  слишком конкретные и длинные условия со множеством проверок и категорий.

if (x === 0) {
...
} else if (x === 50) {
...
} else if (x === 100) {
...
} else if (x > 50) {
...
} else {
...
}

Тем не менее, второй совет  —  противоположность первого: 
НЕ пишите сложные условия ради экономии в пару строк. Если вам придется написать две лишние строки, но код станет понятнее, то пишите эти строки с уверенностью. Проанализируйте следующие два примера:

Первый пример:
if(a || b && c || f && x == y){
...
}
Второй пример:
if(x == y){
if(a){
...
} else if(b){
...
}
else{
...
}
}

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


5. Велосипед вместо встроенной функции

Непонятно, почему до сих пор далеко не каждый разработчик на земле применяет встроенные инструменты и функции. 

Если вам действительно нужно тратить свое время лишь на то, чтобы работодатель нанял побольше сотрудников для переработки вашего кода, то займитесь чем-нибудь другим. Пожалуйста, не наказывайте проект и разработчиков, в дальнейшем читающих ваш код.

В 99 из 100 случаев ваши функции с течением времени станут менее эффективными в плане времени выполнения и требуемой памяти. Не смотря на это, многие программисты даже не знают, что есть хорошая встроенная функция, но уже пишут свои.

Вот почему большинство старших программистов советуют начинающим и младшим специалистам поискать в Интернете лишние пять минут, прежде чем написать собственную функцию.

Самое приятное, что даже если вы не найдете встроенных функций, то узнаете, как решили задачу другие разработчики. Всегда помните, что написание кода  —  лишь одна часть работы программиста, нельзя забывать про важность чтения публично доступных наработок.


6. Игра в загадочные имена

Об опыте программиста можно судить по тому, как он называет функции и классы в своих проектах.

Давайте рассмотрим простой пример: getABC().

Вы догадались, что делает метод? Никто не догадался. Следовательно, следующий программист, прочитавший код, наверняка проклянет вас. Потому что ему, вероятно, придется вчитываться в каждую строчку функции, долго и постепенно понимая, что она делает.

Посмотрите на следующее название: getUserNameFromDB(). Идентификатор метода явно сообщает о предполагаемом результате выполнения.

Некоторые программисты так сокращают название, что становится трудно расшифровать его полную версию. handleBtnClick, getConfig или parseInfo легко понять. Но hndleBtnClk, getCnfg уже слишком коротки. Отбрасывая скуку, рассмотрим ситуацию из жизни:

Один из преподавателей курса снизил оценку за неправильное написание названия функции в лабораторной работе по Java. 
Он поступил так, чтобы студенты в будущем запомнили важность именования.


7. Сплошь глобальные переменные

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

Почему? Много причин для превалирования локальных переменных над глобальными. Поговорим о некоторых основных:

  1. Меньше ошибок и неожиданных результатов.
  2. Когда вы получаете ошибки, то их легко найти.
  3. Серьезное упрощение рефакторинга кода.
  4. Другим программистам в сотни раз сложнее читать ваш код, когда в нем повсеместно применены глобальные переменные.

Если везде только глобальные переменные, значит, вы плохой программист. Извините за обидное, но правдивое высказывание. 


8. Запутанный код

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

Однажды программист ответил, что запутанный код делает компанию зависимой от него  —  работа ему обеспечена. 

Но это очень неправильная концепция, крайне вредная идея. Гораздо лучше руководствоваться следующим:
“Загадочность”  —  плохо. “Легкость”  —  хорошо
.

Пожалуйста, не заставляйте коллег и сослуживцев страдать из-за вашего хобби или попыток выделиться за счет сложности понимания вашего кода другими людьми. Вы сэкономите другим разработчикам часы, если просто напишите элементарный, читабельный код.

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


9. Взаимозависимые функции

Код весьма плох, когда функции выполняются исключительно в строгом порядке. Рассмотрим пример:

start()

begin()

preparing()

end()

Откуда другим программистам знать, что перед процедурой begin() надо вызвать процедуру start()

Функции работают независимо друг от друга

Решением “на каждый раз” послужит специальный метод-шаблон. Рассмотрим пример на языке программирования JavaScript:

function getUserFromDB(){

  function begin(){
    ...
  }

  function preparing(){
    ...
  }

  function end(){
    ...
  }

  begin()
  preparing()
  end()
}

Когда все же необходимо вызывать функции по порядку, то пишется одна внешняя функция start(), со множеством внутренних, вроде begin(), preparing() и end(). Кроме того, внешней функции start() присваивается идентификатор, явно отражающий ее функционал. 


10. Нет понимания сложности алгоритма

Начинающие программисты часто пишут лишние вложенные циклы. Тем более, когда менталитет “достаточно выполнить работу и запустить код” превращает программиста в неэффективного лентяя. Правда, производительность приложения  —  скорее дело привычки:

Когда команда не ценит хороший код и не заботится о качестве, то программисты не заботятся о временной сложности алгоритма и сложности алгоритма по памяти

Если вы разбираетесь в оценке сложности алгоритмов и пишете эффективный код  —  он даст вам силы, а если не обращаете внимание на детали реализации, то не сможете изменить шаблоны, остановившись в развитии профессиональных навыков.

Многие программисты даже не знают про “сложность алгоритма по памяти” или “memory complexity”. Если вы не знаете, пожалуйста, узнайте, ведь это поможет на собеседованиях.


Выводы

Потребуется время, чтобы стать хорошим программистом, но чем дольше вы следите за качеством собственных проектов, тем чище и лучше становится ваш код. Не говорите себе, что со временем все само по себе изучится, но и ученым-ракетостроителем быть не требуется, чтобы написать хороший код.

336   0  
    Ничего не найдено.

Добавить ответ:
Отменить.