Комментарии часто представляют собой запах кода. Их вставка в метод требует срочного рефакторинга.

TL; DR Не добавляйте комментарии в свои методы. Извлекайте их и оставляйте декларативные комментарии только для неочевидных дизайнерских решений.

Проблемы

  • Читаемость
  • Целовать
  • Низкое повторное использование
  • Плохая документация

Решения

1. Метод извлечения

2. Рефакторинг

3. Удалите недекларативные комментарии.

Образец кода

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

Правильно

Обнаружение

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

Теги

  • Читаемость
  • Длинные методы
  • Комментарии

Вывод

Комментарии - это запах кода. Если вам нужно задокументировать проектное решение, вы должны сделать это до фактического кода метода.

связи



Обоняние кода 03 - функции слишком длинные
Людям становится скучно за пределами строки 10. blog.devgenius.io





Запах кода 74 - Пустые строки
blog.devgenius.io





Запах кода 05 - Злоумышленники в комментариях
В коде много комментариев. Комментарии связаны с реализацией и практически не поддерживаются. blog.devgenius.io



Не поддавайтесь на комментарии, они могут ввести в заблуждение: отлаживайте только код.

Дэйв Сторер



Великие цитаты о программной инженерии
Иногда короткая мысль может родить потрясающие идеи. blog.devgenius.io



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



Как найти вонючие части вашего кода
Код плохо пахнет. Давайте посмотрим, как изменить ароматы. blog.devgenius.io