Також відомий як Comments

Запах коду Коментарі

Симптоми і ознаки

Метод містить безліч пояснювальних коментарів.

Причини появи

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

Найкращий коментар — це хороша назва методу або класу.

Якщо ви відчуваєте, що фрагмент коду буде незрозумілим без коментаря, спробуйте змінити структуру коду таким чином, щоб будь-які коментарі стали зайвими.

Лікування

  • Якщо коментар призначений для того, щоб пояснити складний вираз, можливо, цей вираз краще розбити на більш зрозумілі підвирази за допомогою відокремлення змінної.

  • Якщо коментар пояснює цілий блок коду, можливо, цей блок можна витягнути в окремий метод за допомогою відокремлення методу. Назву нового методу вам, скоріш за все, підкаже сам коментар.

  • Якщо метод вже виділений, але для пояснення його дії, як і раніше, потрібен коментар, дайте методу нову назву, що не вимагає коментаря. Використайте для цього перейменування методу.

  • Якщо потрібно описати якість правила, що стосуються корректної роботи методи, спробуйте рефакторинг введення твердження.

Виграш

  • Код стає очевиднішим і зрозумілішим.

Не варто чіпати, якщо...

Іноді коментарі бувають корисними:

  • Ті, що пояснюють чому щось виконується саме таким чином.
  • Ті, що пояснюють складні алгоритми (коли всі інші засоби спрощення алгоритму вже були випробувані).

Замучились читати?

Збігайте за подушкою, в нас тут контенту на 7 годин читання.

Або спробуйте наш новий інтерактивний курсу. Він набагато цікавіший за банальний тест.

Дізнатися більше...