Иногда меня просят посмотреть код разных проектов и почти везде я замечаю одну и ту же ошибку. Выглядит она не сильно страшно, но отражается на проекте и настроении команды серьёзно.
Итак, хламовник, он же чулан, он же балкон в типичной русской квартире — всеми силами избегаемое место, где лежит куча всякой непонятной и совершенно не нужной дряни, которую по необъяснимым или нелогичным причинам жалко выкинуть. Именно в такое место частенько превращаются it-проекты. В них встречаются куски закомментированного кода, файлы вроде main.css_old
, неиспользуемые методы, по пять версий jQuery, // TODO:
и т.д.
Итак, почему это плохо и в то же время совершенно бесполезно:
- Теория разбитых окон отлично работает в IT-проектах.
- Частенько огромные закомментированные куски в CSS и JavaScript отдаются пользователю, увеличивая время загрузки страниц.
- На чтение закомментированного уходит время.
- Большое количество неиспользуемых файлов может на неделю ввести новичка на проекте в ступор.
- Работать с таким проектом неприятно. Создаётся ощущение говнокода даже если код нормальный.
- В компилируемых языках может существенно увеличится время компиляции.
- Всё это и так хранятся в используемой вами системе контроля версий.
Отдельно стоит упомянуть //TODO:
. В коде их вряд-ли кто-то будет воспринимать серьёзно и действительно к ним возвращаться. Если необходимо отложить что-то на потом, лучше завести задачку в трекере (ну или где там у вас хранятся задачи) и никаких //TODO:
в самом коде не писать.