?

Log in

No account? Create an account
November 2016   01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
cartoon

Читай код

Posted on 2009.05.03 at 16:01

Comments:


vp at 2009-05-03 18:06 (UTC) (Link)
Тут явно должен быть какой-то разумный компромисс. В другой крайности бурно развивается "синдром генерального конструктора", когда основные идеи находятся у автора в голове, и они настолько сложны для передачи кому-то, либо эта передача оценивается настолько дорого, что контора начинает жить мыслью "Только бы он не помер".
ЗЫ Мой подход в этом деле - это вставлять куски документации прямо в код, в модули, с обильными комментариями. Если делаем, к примеру, парсер протокола, то в коде всегда будут куски примеров протокола с расшифровками и т.п. Я думаю, это подход достаточно оправданный, плюс пишется все ОДНОВРЕМЕННО с кодом (!), плюс ничто никуда не потеряется.
Gaperton
gaperton at 2009-05-03 18:13 (UTC) (Link)
Это и есть примерно то, о чем я говорю.
Дмитрий Арсентьев
dmarsentev at 2009-05-08 15:27 (UTC) (Link)

Ответ однозначный: или да, или нет наверняка. 100%. Без ва

Вы пишете (резюмирую), что
Документация - это мусор и надо читать код.

Вам vp говорит (резюмирую): "А мы всё-таки
считаем, что документация - это правильно и хорошо,
и поэтому вставляем её прямо код."

Вы на это отвечаете:
"Это и есть примерно то, о чем я говорю."

Извините, но вы говорили противоположную вещь.
Вы уж как-нибудь определитесь ;)

Жаль, что вы сделали слишком слабый акцент в статье на том факте,
что, после того как вы прослушали курс по архитектуре системы,
вы переписали свой кусок полностью заново.
Никакое справедливо хвалимое вами чтение исходного кода
не помогло вам осознать систему в целом.

Я не спорю с вашим посылом, что код читать надо.
Но что касается меня, то для меня
чтение написанной мною же документации в коде
на порядок, если не больше,
ускоряет повторное вхождение в код через полгода-год.
Читая свои комментарии, я думаю: Господи,
какой же добрый, умный, хороший человек так
ласково, подробно и не жёстко всё описал.
И после короткой интеллектуальной паузы:
Господи, так это я так хорошо всё описал.
(Слёзы благодарности к себе.)
Неужели у вас такого не было?

Считаю, что даже устаревшая документация может быть полезна,
если в ней описаны корневые идеи,
а реализация этих идей не очень сильно изменилась.
Gaperton
gaperton at 2009-05-08 19:34 (UTC) (Link)

Re: Ответ однозначный: или да, или нет наверняка. 100%. Без

""Это и есть примерно то, о чем я говорю."

Извините, но вы говорили противоположную вещь.
Вы уж как-нибудь определитесь ;)"

Я определился. Это примерно то же самое, что я и говорю. Читать надо то, что написано, а не что-нибудь еще. Если вы сделаете это внимательно, а еще так же внимательно изучите мои комментарии в теме, и перестанете думать, что пишете в журнал умственно отсталого идиота - у вас в голове все исчезнут все противоречия.

"Читая свои комментарии, я думаю: Господи,
какой же добрый, умный, хороший человек так
ласково, подробно и не жёстко всё описал.
И после короткой интеллектуальной паузы:
Господи, так это я так хорошо всё описал.
(Слёзы благодарности к себе.)
Неужели у вас такого не было?"

Было ровно то же самое, да. В чем вы видите противоречие? Комментарии - неотъемлемая часть кода. Даже doxygen-комментарии, по которым генерируется документация - есть неотъемлемая часть кода.

Если вы будете читать что написано, то вы прочтете не только то, что хотите, но и например странное сочетание literate programming в конце статьи. Прочитайте. Если вы примените гугл для поиска, вы поймете, что это такое. И может быть после этого у вас появится небольшое сомнение в том, что автор групее вас. Это, для начала, уже не так плохо.
no_gritzko_here
no_gritzko_here at 2009-05-04 21:05 (UTC) (Link)
Да, идеальный встреченный мной пример - Google v8. Свежий чистый код, единый архитектурный замысел, аккуратно откомментирован. Читается, как новелла. Приятно.
И главное, ничего суперхитрого, просто культура.
Previous Entry  Next Entry