А потом спустя неопределенного количества изменений кода только этот комментарий поможет опознать, что это когда то была собака.
раскрыть ветку (6)
комментарий поможет опознать, что это когда то была собака.
Звучит как затравка для ужастика.
раскрыть ветку (4)
иногда такое в жизни бывает - писали одно, а со временем с дописками получился ужасный монстр.
раскрыть ветку (1)
Если соблюдать все принципы best practice, то этого можно избежать. К примеру тот же SOLID.
Правилом грамотного комментирования (для чего, конечно же, нужен опыт) является описание того, для чего этот кусок кода нужен, а не что он делает, потому что второе как правило и так очевидно. Хороший код должен комментировать сам себя, поэтому комментариев в хорошо написанном проекте должно быть минимум и они должны объяснять только логику работы программы. Т.е. и так понятно, что делает метод saveUserProfile(), но вот почему он вызывается именно вот здесь - не всегда.
IT-юмор
7.5K поста53.3K подписчиков
Правила сообщества
Не публикуем посты:
1) с большим количеством мата
2) с просьбами о помощи
3) не относящиеся к IT-юмору