Ты документируешь код?
Ты его хорошо документируешь?
Нет, ты не документируешь код и особенно самые очевидные в данный момент места... Ты такой!... непутевый!
И именно эти очевидные тогда отрывки кода, потом становятся главным говнокодом в проекте.
Утешу, ты такой не один.
Или один, в том смысле, что ты хорошо документируешь код?
КТО ТЫ?!!! ))))
Каждую функцию комментирую, вызовы, иногда даж класс, структуру или объявление переменной. На инглише всегда, а как же по другому?
Код должен быть самодкументирующимся.
Код должен сам для себя писать документацию? Вариант)
У автора должность: SEO Owner
Он же больной.
Твой код говно если ему необходимы комментарии.
Мой код тоже говно, если ему необходимы комментарии.
Если ты о комментариях — комментирую только то, чего сам не понимаю (например кусок, скопированный с SO сопровождаю ссылкой)
Зачем вы используете ДОУ в качестве личного твиттера?
Какой-то слабый вброс для пятницы, ТС мало каши ел. Хороший код не нуждается в комментариях. Если на код надо адски много комментов, через строчку буквально, то это попытка прикрыть дерьмо газеткой замаскировать свою лень и нежелание потрудиться над кодом. Еще хуже когда код и документация идут в рассинхрон, а такое бывает буквально после
комментирование и документирование это, на минуточку, не одно и то же...
хороший код самодокументируемый )) если уж придираться к словам.
Хороший документ самокодируемый!
Хороший код самокотируемый! (Или кот самокодируемый?)
Хороший кот — хороший кот.
хороший код — самокоментируемый. Самодокументируемый — это лажа какая-то. Код не должен объяснять рабочую область.
Я вот щас даже проникся сочувствием к тому человеку, который будет поддерживать написанную вами лапшу, которую вы почему-то гордо назвали самодокументирующимся кодом.
ну вообще на проектах, которыми пользуется потом коммьюнити, например, нельзя не документировать
Да и много людей для себя это делает. Так что ты один такой — недокументирующий
А что, документированный говнокод перестает быть говнокодом? :)
ну я давно говорил что на доу настоящих програмистов мало и они очень редко что комментируют. Всегда документирую код
Потому, что проще потом всем дуль натыкать! ))))
надо бы специалиста навестить если это волнует
доку пишу очень редко, толко если нужно обьяснить какой то финт ушами вмето очевидного подхода.
Документировать надо не «очевидные места», а намерения. Что конкретно по твоему мнению делает этот код. А ещё чаще, практически всегда, документировать нужно ЧТО ЗАПОМИНАЕТ этот код, и ОТКУДА он берёт то, чем пользуется.
Особенное требование к документации кода, который должен служить примером. Когда вы отрываете код от исходного проекта, чтобы кому-то что-то показать, или же перенести в другой код хорошую практику — нужно описывать каждую переменную, видимую далее оторванного куска.
В противной случае срок жизни этого кода примерно как у свободного нейтрона.
Документировать надо не «очевидные места», а намерения.
Case in point: есть большая разница между чтением 10KB документации и чтением 10MB самодокументирующегося (по мнению авторов) кода. Особенно если цель понять общую картину.
Популярный вопрос, на который может отвечать документация и почти никогда не отвечает код — «НАХ*Я???!»
Омг... вы вообще понимаете разницу между документации архитектуры и кода?
Никакой. Читаемо должно быть ВСЁ, что вы не собираетесь поддерживать пожизненно единолично. Последнее тоже должно, но лишь в этом случае это будут ваши проблемы.
И коль скоро всё должно быть понимаемо — всё должно быть документировано примерно в одинаковой мере. И как можно ближе к тому месту, где оно понадобится.
Большая документация и книги от «писателей» — малополезны, поскольку писаны ради количества страниц, а не ради качества.
А когда на этот вопрос не отвечает 10Mb документации — это называют «интересная работа» и «challange». Хотя по факту попытка довести такое счастье до использования в продакшене занимает месяцы, но когда решение принимают «ыфиктивныи мэныджыры» — выходит что реально тратится несколько человеко-месяцев, вместо того чтобы заплатить лишних 100 баксов за альтернативный продукт, в котором всё работает «из коробки», документация есть в каждой точке, с минимумом бюрократии, а пожизненный саппорт идёт в комплекте.
Из всех мест отсутствующей документации собственно код не самое критичное место. Бывают места, но редко.
Мама! Он меня посчитал!
Крайне странный пост...
Видимо, к Четвергу человек не выдержал — нервы сдали :)
Да нам за вредность молоко давать нужно.
Что разработка с людьми делает?..
Чуть чуть не додержал в себе:)
Хороший код не нуждается в документации. А вы облажались с говнокодом?
Вы изволите крайне переоценивать domestic developers, на которых through security reasons меняют overseas developers, которые суть дикари.
Доки пусть будут.
Ах цей міфічний сферичний кінь в вакуумі
Хороший код) Всі про нього чули, але ніхто не бачив)
Хороший код не нуждается в документации.так думает каждый, но не каждый пишет хороший код, улавливаете?
Когда бизнесс логика проекта очень сложная, то это не работает, код понятный и читабельный, вот только зачем это все, откуда, куда, а главное чем эти сущности отличаются от «соседних» нифига не понятно.
и это и есть показатель того что это решение хуевое, если было бы хорошое то документация не нужна была бы.
большинство не могут делать даже простые вещи просто, а сложные сделать простыми еще сложнее, в этом и вся суть сеньорства
Попробуйте написать энтрепрайз приложение с таким подходом. Чтобы глянул код и сразу все понятно, что нужно кастомерам.
Если возникает потребность документировать код (не АПИ) то у вас х****й код
Она возникает ПОЗЖЕ, когда по факту оказывается что дешевле переписать. А ТЗ... да, было ТЗ, оно бы всё разъяснило, если бы хоть частично оказалось в документации.
когда по факту оказывается что дешевле переписать
то у вас х****й код
ну почему же, джунов всех нужно обязать писать доки. Ну и индийских программистов тоже :) у них очень спецефический код обычно
джунам поможет код ревью, а документировать они все так же не смогут хорошо и понятно
очень часто, когда код приходит с аутсорса уже написанный специалистами из солнечной индии, так на чтение этого, кхм, кода уходит больше времени, чем на реализацию новых фич... поэтому, лучше сразу документировать, если понял как эта хрень работает — чтоб другие члены комманды не мучались.
не, вы не поняли. если человек изначально не может это назвать нормально, он и не сможет документацию написать
Обычно так говорят те , кто этот же х****й код и пишет.
мой скромный опыт говорит мне об обратном. но это ваша точка зрения
хороший код очень сложно коментировать, только капитан очевидность может справится с такой задачей и подписать метод Save комментарием «Save »
обычно коментируют говнокод, чтобы объяснить что он делает, когда не хотят его переписывать, реально дельных коментариев практически никогда не встретишь, только капитанство и объяснения что хранится в переменной «temp»
недавно пришлось задокументировать один класс — ибо было херовое решение, к сожалению иначе нельзя было решить, вот и пришлось, но это был четкий показатель того что эта сущность крайне хуевая
Vlad Lee SEO Owner «GPDP»
Seoшники они обычные люди просто они хотят немного темла, любви, скачать бесплатно и без смс.
Чувак, чего ты докопался до меня?
Я всего лишь пиццу вам доставляю.
Лампочку на место верни!
Petro Iontsev
anonymous
Oleksandr Katykhin
Blitz
Alex Koshterek
Andrii Serhiienko
Владислав Фурдак
Maksym Mospanenko
John Appleseed
Gennady Dogaev
Дмитрий Клименко
Oleg Kariakin
Yaroslav Pernerovsky
Oleg Kariakin
Молдавский Узбек
Valentin Nechayev
Андрій Плотніков
Андрей Литвинов
Andrey Reshetchenko
Sereban
Тимур Ярош
NoName
Нестор Иванович
Нестор Иванович
Олексій Пєніє
Jorzchyk Pushysty
anonymous
Олексій Пєніє
Valentin Nechayev
TechnoBarbarian
Eugene Suleimanov
Oleksii Pavlov
Oleh Kamyshanov
Микола Лавренко
Infatum
Bot Bot
Oleh Kuchuk
Vadim Kopanev
Vadim Kopanev
Nikita Podgorbunskyi
John Appleseed
Alexander Azarov
66 коментарів
Додати коментар Підписатись на коментаріВідписатись від коментарів