суббота, 29 мая 2010 г.

Комментарии

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

“Дядюшка” Боб Мартин. “Чистый код”

5 комментариев:

  1. Комментарии приводят нас к плохому коду, издающему все гнилые запахи, о которых мы писали...
    ...Почувствовать потребность написать комментарий, попробуйте сначала изменить структуру кода так, чтобы любые комментарии стали излишними...
    Мартин Фаулер "Рефакторинг. Улучшение существующего кода."

    ОтветитьУдалить
  2. Обе эти книги ("Чистый код" и "Рефакторинг") пересекаются по многим темам, в частности о качестве кода. Поэтому "дядюшка" Боб этой фразой не говорит ничего нового, но при этом делает он это здорово:)

    ОтветитьУдалить
  3. К этим цитатам еще можно добавить слова Стива Макконнелла ("Совершенный код"): "Хороший код сам является самой лучшей документацией. Если код настолько плох, что требует объемных комментариев, попытайтесь сначала улучшить его." и "Комментарии должны сообщать о коде что-то такое, что он не может сообщить сам.".
    Что касается лично моего мнения, то на 100% согласна, что код должен быть ясным - ясные имена методов, переменных, классов и т.д. Методы должны выполнять четко определенные действия, которые исходят из имени метода, переменные должны использоваться только по назначению и т.д. - обо всем этом не раз говорилось во всех вышеперечисленных книгах ("Совершенный код", "Рефакторинг"...), а так же в ряде других не менее интересных книг...
    И напоследок еще одна цитата Стива, которая ну очень мотивирует писать ясный код - "Пишите код, исходя из того, что все программисты, которые будут сопровождать вашу программу, - склонные к насилию психопаты, знающие, где вы живёте." :)

    ОтветитьУдалить
  4. @tan4eg: совершенно согласен со всем вышесказанным, это подтверждают как множество других авторов, так и опыт любого, кто хотя бы несколько лет проработал в разработке ПО.
    Спасибо за цитаты (с вашего позволения и ссылкой на вас с радостью их опубликую).
    А что касается последней цитаты, то я уже толком не уверен, кто является настоящим ее автором. Как минимум она еще есть у Джона Роббинса в его книге по отладке и там он ее приписывает кому-то (но не Стиву):)

    ОтветитьУдалить
  5. Да, по поводу последней цитаты... судя по всему, это уже фольклор :)

    ОтветитьУдалить