Запахи кода в разработке XOOPS

Обзор

Запахи кода - это показатели потенциальных проблем в коде. Они не обязательно означают, что код сломан, но они указывают на области, которые могут извлечь выгоду из рефакторинга.

Дутые коды

Длинный метод

Метод делает слишком много - разделите на несколько методов, каждый с одной ответственностью.

Большой класс (Объект-Бог)

Класс делает все - разделите на сфокусированные классы для каждой ответственности.

Длинный список параметров

Используйте объекты параметров вместо списков отдельных параметров.

Нарушители объектной ориентации

Операторы Switch

Используйте полиморфизм вместо проверки типов с использованием операторов switch.

Временное поле

Поля используются только в определенных ситуациях - передавайте как параметр или возвращаемое значение.

Препятствия к изменениям

Расходящееся изменение

Один класс изменяется по множеству разных причин - разделите ответственность.

Хирургия дробовика

Одно изменение требует множество отредактированных файлов - централизуйте общую функциональность.

Расходуемые

Мертвый код

Удалите недостижимый или неиспользуемый код из кодовой базы.

Дублированный код

Извлеките общую логику в утилиты или трейты для переиспользования.

Соединители

Зависть функции

Метод использует данные другого объекта больше, чем свои собственные - переместите поведение на объект с данными.

Чеклист рефакторинга

При обнаружении запаха кода: определите, оцените, спланируйте, тестируйте и рефакторьте.

Связанная документация

• Clean Code Principles
• Code Organization
• Testing Best Practices