Перейти к содержимому


Фотография

Комментарии в коде и почему сейчас это так стало плохо?


  • Авторизуйтесь для ответа в теме
Сообщений в теме: 8

Опрос: Комментарии в коде и почему сейчас это так стало плохо? (14 пользователей проголосовало)

Ваше отношение к комментариям в коде?

  1. Да! Комментарии это ужасно, код должен сам себя описывать! (1 голосов [7.14%] - Просмотр)

    Процент голосов: 7.14%

  2. Нет, комментарии должны дополнять код ! (13 голосов [92.86%] - Просмотр)

    Процент голосов: 92.86%

Голосовать Гости не могут голосовать

#1 spaces_dima

spaces_dima

Отправлено 01 Май 2019 - 16:46

В последнее время, набирает популярность мысль, что комментарии в коде — дело не обязательное, и даже вредное.

“Комментарии — первый признак плохого кода”

"Код должен описывать сам себя"

"Комментарии могут устареть"

С другой стороны, комментарии должны дополнять код, тем самым вы сэкономите кучу времени и сил своим коллегам

Да в теории вполне можно выдавать хороший и читаемый код, но в реальных проектах не всегда хватает времени на качественный рефакторинг

Бизнес логика иногда настолько сложна что без 100 грамм ее не реализуешь, а когда реализуешь хочеться помыть руки раз пять после такого кода

или то что красиво и логично вам может вызвать затруднения у других и как в этом случае код может сам себя описать? 

Несколько слов о описании каких либо действий хоть как то облегчать жизнь вашему коллеги или тому человеку который читает такой код



#2 eRIC

eRIC
  • Модераторы
  • Cообщений: 1 694
  • Регистрация: 18-11-2004

Отправлено 16 Май 2019 - 20:30

spaces_dima, в век "каждый сам за себя" перестали думать о написании лишних словечек и комментариев. со временем все пришло к тому что: "сам понимаю и знаю, до остальных барибир"



#3 ком@рик зверь

ком@рик зверь

Отправлено 19 Май 2019 - 21:55

Главное правило хорошего кода. Пиши код для людей.

#4 IT Lessons

IT Lessons

Отправлено 21 Май 2019 - 17:52

Комментарии нужны и особенно полезны тогда, когда они как минимум отвечает на вопрос "что здесь (в коде) происходит?", а как максимум - "зачем здесь это происходит?" Комментарии которые отвечают на вопрос "как это происходит?" - и впрямь зачастую бывают бесполезными, но только если речь не идет о сложной логике исполнения кода... но если логика сложна, то как правило имеет место отсутствие принципа функционального разделения.



#5 spaces_dima

spaces_dima

Отправлено 05 Июнь 2019 - 00:02

к сожалению сейчас многие начинают комментарии не писать..  И когда опишешь хоть в паре слов что дает данная бизнес логика, начинают считать, не человеком)



#6 eRIC

eRIC
  • Модераторы
  • Cообщений: 1 694
  • Регистрация: 18-11-2004

Отправлено 05 Июнь 2019 - 21:27

spaces_dima, если код как минимум соблюдается парадигмы self-explanatory/self-documenting code, то написание доп. комментарий считаю излишним.



#7 eRIC

eRIC
  • Модераторы
  • Cообщений: 1 694
  • Регистрация: 18-11-2004

Отправлено 27 Июнь 2019 - 22:38

недавно в сети наткнулся на такое высказывание: Code never lies, but comments sometimes do :)



#8 SomeQ

SomeQ

Отправлено 05 Июль 2019 - 09:56

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

#9 CyberLight

CyberLight

Отправлено 12 Август 2019 - 12:06

Комментарии - признак запутанного и сложного кода. Комменты могут не обновляться и стать не актуальными. Их часто забывают обновлять + это еще и добавляет напрягу новому человеку. Лучше разговаривать на уровне названий функций, в которые выносятся часть логики, а название функции четко отражает что эта логика делает ).  Название переменных, классов, тоже имеет важную роль. А еще структура проекта. 






Количество пользователей, читающих эту тему: 0

0 пользователей, 0 гостей, 0 анонимных