Нам нужно внести некоторые изменения. Нам нужно четко понимать, почему
TL;DR: будьте декларативными в своих решениях по дизайну или реализации.
Проблемы
- Комментарии к коду
- Отсутствие тестируемости
Решения
- Будьте откровенны о причинах.
- Преобразуйте комментарий в метод.
Контекст
Иногда мы находим произвольные правила, которые не так легко проверить.
Если мы не можем написать провальный тест, нам нужна функция с отличным и декларативным именем вместо комментария.
Образец кода
Неправильный
// We need to run this process with more memory set_memory("512k)
run_process();
Верно
increase_memory_to_avoid_false_positives();
run_process();
Обнаружение
[X] Полуавтоматический
Это смысловой запах.
Мы можем обнаружить комментарии и предупредить нас.
Теги
- Комментарии
Заключение
Код — это проза. И дизайнерские решения должны быть описательными.
связи
Отказ от ответственности
Code Smells — это всего лишь мое мнение.
Кредиты
Фото автора Goh Rhy Yan на Unsplash
Программы, как и люди, стареют. Мы не можем предотвратить старение, но можем понять его причины, ограничить его последствия и обратить вспять некоторые повреждения.
Марио Фуско
Эта статья является частью серии CodeSmell.