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

TL;DR: Следуйте правилу бойскаута дяди Боба.

  • Читабельность

  • Ремонтопригодность

  1. Оставь код лучше

  2. Измени это

Мы читаем код гораздо чаще, чем пишем.

Мы должны взять на себя ответственность за код с ошибками и оставить его лучше.


Неправильный

    int mult(int a,int  other) 
    { int prod
      prod= 0; 
      for(int i=0;i<other  ;i++) 
        prod+= a ; 
         return prod; 
    } 

// Formatting, naming, assignment and standards inconsistent
Войти в полноэкранный режим

Выйти из полноэкранного режима


Верно

int multiply(int firstMultiplier, int secondMultiplier) {
  int product = 0; 
  for(int currentIndex=0; currentIndex<secondMultiplier; currentIndex++) {
    product += firstMultiplier; 
  }
  return product; 
} 

// or just multiply them :)
Войти в полноэкранный режим

Выйти из полноэкранного режима

[X] Полуавтоматический

Мы можем использовать другие детекторы запаха кода и оставить код в лучшей форме.

Мы должны следовать правилу бойскаута и оставить код лучше.

Code Smells — это только мое мнение.

фото Павел Червински на Скрыть


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

Энди Хант


Эта статья является частью серии CodeSmell.