ConstructiCat Logo
CodeBust.
Browse section ▾

Комментарии.

Метод содержит множество поясняющих комментариев.

##Signs and Symptoms

Метод содержит множество поясняющих комментариев.

##Reasons for the Problem

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

Самый лучший комментарий — это хорошее название метода или класса.

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

##Payoff

  • Код становится более очевидным и понятным.