Логотип ConstructiCat
CodeBust.
Навигация по разделу ▾

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

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

##Признаки и симптомы

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

// разрешить доступ администраторам и владельцу
if (user.role == Role.ADMIN || order.ownerId == user.id) {
  show(order);
}

##Причины проблемы

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

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

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

##Лечение

##Результат

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