Комментирование исходников

Григорий Петров (Digtal October)
Moscow Django Meetup №16
10 декабря 2013
Как и что комментировать в исходном коде ваших программ, чтобы комментарии принесли максимальную пользу.
moscowdjango.ru...

[@soam8175]

Просто обожаю доклады Григория, мужик так рассказывает доходчиво и понятно, что просто заслушиваешься =)

[@dronovdmitry]

Спасибо большое. Григорий как всегда мастерски легко говорит о сложном

[@mixassio]

Чувак на заднем плане в носу ковыряется прикольно)

[@Pavluha901]

Мужик помешался на этом кошельке.

[@WorldCount]

Это я хорошо нашёл этот канал)) Спасибо вам за ваши видео.

[@WorldCount]

Очешуетительный мужик.

[@sergeyivanov7709]

Спасибо! Григорий!

[@armanbadalian]

Да, очень приятно слушать)

[@Das.Kleine.Krokodil]

Добавьте имя автора куда нибудь, а то это видео не найдется при поиске по имени автора

[@W_0_W]

Ещё не досмотрел, может автор об этом говорил, но я считаю, что у каждого проекта должна быть солидная документация. По этому я за штуки вроде javadoc, jsdoc и тому подобные, которые генерируют вики из комментов. Если такие штуки недоступны, то нужно писать вики ручками (например markdown + mkdocs), а сами оп себе комменты вещь не очень нужная.

[@W_0_W]

Поржал конечно с фразы "документация раздуется и улетит на орбиту". Честно говоря не согласен. Чем документация больше, тем лучше. Главное чтобы вся информация была строго структурирована и чтобы было побольше гиперссылок между разделами.

[@cupofcode1170]

@@W_0_W есть такая проблема, когда в команду приходит человек и получает на почту гайд-бук-документацию-проекта на 500 страниц. отпугивает от работы достаточно сильно.

[@cupofcode1170]

просто представь документацию к проекту, которую ты изучаешь неделю перед началом работы. это ад. это и есть проявление complexity problem.

[@W_0_W]

@@cupofcode1170 ну не знаю, мне кажется, вполне можно сравнивать эту документацию с википедией. никто ж не читает википедию всю, точно так же никто не заставляет читать документацию целиком. новичков нужно тыкать только на те разделы, с которыми им предстоит работать.

[@user-zg2bx5cb3d]

а он постройнел за 8 лет