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
Есть и обратная сторона - слишком много комментариев, в них начинаешь теряться и получается, что проще было просто прочитать код. Или самый смак - когда подписана элементарщина, типа
//складываем a и b
//берём последний элемент массива
//сортируем массив
но абсолютно ничего не написано, почему вместо очевидного решения было сделано именно вот так, или зачем мы сделали вот это в середине - это необходимый хак или тупо косяк?
Я соглашусь, что есть красивый код, в котором нет методов на 100 строк, архитектура продумана и изящна, но мы работаем в реальном мире, с дедлайнами и человеческими ошибками, поэтому практика показывает, что лучше комментить хотя бы общую структуру и непонятные моменты, времени это отнимает минимум но поможет другим в будущем, ну или тебе же через пару месяцев.
Если код плохой, то там очень часто и комментарии бесполезны.
>> Когда ты видишь метод на 100 строк, и основные функциональные блоки в нём подписаны
Ну 100 еще ладно, а вот если больше, то я такой пулл реквест заворачиваю и говорю переделать. Нормальный код на тех же дедлайнах времени много сэкономит.
Разбить метод на логические блоки труда много не требует, а читаемость повышает в разы лучше всяких комментариев.
Я проект веду, вот недавно тулзой cloc смотрел, 150k с лишним строк кода. Комментов по минимуму, они есть только там где матана много или там где хаков много. Без проблем разбираю код написанный 3 года назад, даже если он написан не мной.
Архитектура, к слову, не везде продумана, и не везде изящна.
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
>> но абсолютно ничего не написано, почему вместо очевидного решения было сделано именно вот так, или зачем мы сделали вот это в середине - это необходимый хак или тупо косяк?
Я так и написал:
>> Нужно комментировать всякие хаки, костыли и т.д. но еще лучше их не делать.
Часто бывает, что когда пишешь - все очевидно, а заходишь через неделю/месяц/год, и приходится вспоминать. В таком случае пишу комментарии. Иногда бывает такая ебанина, что пока пишешь, уже перестаешь понимать, в этом случае приходится писать описание сразу.
Из всех неоднозначных объектов ( полоса движения только для автобусов, непонятное строение за автобусом, непонятная будка около магазина) и т. Д) комментарий есть только на 1м объекте) и то, непонятно зачем т.к и из параметров ясно что это ге самолет.