Когда комментируешь абсолютно все в своем коде

песочница 

Когда комментируешь абсолютно все в своем коде

песочница



Подробнее

песочница
Еще на тему
Развернуть
Так и надо!!!
Apokal17 Apokal17 04.11.201912:16 ответить ссылка 7.0
++
Я не соглашусь. Когда ты видишь метод на 100 строк, и основные функциональные блоки в нём подписаны, ты потратишь двадцать секунд на то, чтобы пробежаться по комментам и понять логику, и найти нужный тебе кусок, а иначе тебе надо просмотреть весь код от начала до конца и загрузить его в церебральный интерпретатор, это явно дольше и напряжней.

Есть и обратная сторона - слишком много комментариев, в них начинаешь теряться и получается, что проще было просто прочитать код. Или самый смак - когда подписана элементарщина, типа

//складываем a и b
//берём последний элемент массива
//сортируем массив

но абсолютно ничего не написано, почему вместо очевидного решения было сделано именно вот так, или зачем мы сделали вот это в середине - это необходимый хак или тупо косяк?

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

Если код плохой, то там очень часто и комментарии бесполезны.

>> Когда ты видишь метод на 100 строк, и основные функциональные блоки в нём подписаны

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

Я проект веду, вот недавно тулзой cloc смотрел, 150k с лишним строк кода. Комментов по минимуму, они есть только там где матана много или там где хаков много. Без проблем разбираю код написанный 3 года назад, даже если он написан не мной.
Архитектура, к слову, не везде продумана, и не везде изящна.
int16 int16 04.11.201913:37 ответить ссылка -0.6
Мой посыл был в том, что не всегда тебе в руки попадает хороший код, и тогда лучше иметь коменты, и даже хороший код на мой взгляд читается быстрее, если он базово описан комментами. Кроме того, хочу добавить, что при написании комментария я лично ещё раз критично просматриваю код, и при этом нередко улучшаю его структуру.
К прочтению по теме:
https://medium.com/@fagnerbrack/code-comment-is-a-smell-4e8d78b0415b
https://visualstudiomagazine.com/articles/2013/07/26/why-commenting-code-is-still-bad.aspx
https://blog.usejournal.com/stop-writing-code-comments-28fef5272752
https://www.freecodecamp.org/news/code-comments-the-good-the-bad-and-the-ugly-be9cc65fbf83/
https://blog.codinghorror.com/coding-without-comments/
https://stackoverflow.com/questions/209015/what-is-self-documenting-code-and-can-it-replace-well-documented-code

>> но абсолютно ничего не написано, почему вместо очевидного решения было сделано именно вот так, или зачем мы сделали вот это в середине - это необходимый хак или тупо косяк?

Я так и написал:
>> Нужно комментировать всякие хаки, костыли и т.д. но еще лучше их не делать.
int16 int16 04.11.201913:44 ответить ссылка -0.1
Еще лучше разбить функциональные блоки не комментариями, а вынести методы. Хоть и не всегда это легко сделать.
ЛОВИТЕ
НАРКОМАНА!
Egregor Egregor 04.11.201915:59 ответить ссылка -1.5
Может ты гений. И с бегло понимаешь понимаешь входы-выходы методов, смысл переменных и констант заданных в корне класса. Но не все на столько мамкины кацкеры. И твой наследник, садясь за твой код через пару лет тебе спасибо скажет за комменты.
Egregor Egregor 04.11.201916:03 ответить ссылка -0.7
Но очень быстро надоедает коментить "и так очевидные вещи", которые не можешь разобрать на следующий день и проклинаешь себя за лень, обещаешь коментить каждый кусок кода, но очень быстро надоедает коментить "и так очевидные вещи"
Для себя я определился, что комментирую вещи, которые мне непонятны.
Часто бывает, что когда пишешь - все очевидно, а заходишь через неделю/месяц/год, и приходится вспоминать. В таком случае пишу комментарии. Иногда бывает такая ебанина, что пока пишешь, уже перестаешь понимать, в этом случае приходится писать описание сразу.
blockan blockan 04.11.201913:24 ответить ссылка -0.1
GoZlliaff GoZlliaff 04.11.201912:20 ответить ссылка 17.8
iNji iNji 04.11.201912:26 ответить ссылка 18.5
Это что ответ на "наряжаем елку вместе?")
Veanak Veanak 04.11.201920:46 ответить ссылка 0.1
Скорее это то, как обычно комментируетмя любой сложный код.
Из всех неоднозначных объектов ( полоса движения только для автобусов, непонятное строение за автобусом, непонятная будка около магазина) и т. Д) комментарий есть только на 1м объекте) и то, непонятно зачем т.к и из параметров ясно что это ге самолет.
crom crom 04.11.201912:31 ответить ссылка 0.2
Потому что все будут думать, что это АВТОбус, а он ЭЛЕКТОбус. Вот ты, например, перепутал. Все остальные элементы понятны, а этот неоднозначен
Фото с Савка, я там живу оО
По-моему это бабочка.
Только зарегистрированные и активированные пользователи могут добавлять комментарии.
Похожие темы

Похожие посты
Il (ANK Vf XJ I OH IIUYINC.
Ill Ri A HI Il II SU RS IODOWNIOAD YOUR DIGIIAL COPY
1. CO TO WEAREVINVL.COM
2. HAVE YOUR CODE READY AND FOLLOW THE INSTRUCTIONS ON THE ABOVE WEB PAGE
TO GET YOUR DOWNLOAD.
lOK PROMOI ION Al PURPOSfS ONIY OlIfltVAI IDUNIIl H 0? JUli ( .ODD I OH ONI Al HUM DOWNLOAD O
подробнее»

код промо код музыка

Il (ANK Vf XJ I OH IIUYINC. Ill Ri A HI Il II SU RS IODOWNIOAD YOUR DIGIIAL COPY 1. CO TO WEAREVINVL.COM 2. HAVE YOUR CODE READY AND FOLLOW THE INSTRUCTIONS ON THE ABOVE WEB PAGE TO GET YOUR DOWNLOAD. lOK PROMOI ION Al PURPOSfS ONIY OlIfltVAI IDUNIIl H 0? JUli ( .ODD I OH ONI Al HUM DOWNLOAD O
Скрытый номер
2 Входящий вызов
V.
Введите код
Дождитесь входящего вызова и введите последние 6 цифр номера, с которого звонят
Позвонить снова через 49 сек.
подробнее»

код звонок

Скрытый номер 2 Входящий вызов V. Введите код Дождитесь входящего вызова и введите последние 6 цифр номера, с которого звонят Позвонить снова через 49 сек.