как часто вы пишете код без комментариев?

код не писал, но если бы писал, комментировал бы

Всегда. Подом в отдельном бранче прикручиваю явадоки

там конечно ничего сложного.
даже я (по сути 1й раз взялся за такое) обложившись парой мануалов почти раскурил.
но сам факт...

да и мля. уж таблицу стилей на кучу строк можно же хотя бы на блоки разбить.

И то не всегда проясняющие дело) Кроме меня код редко кто смотрит

Nobody cares!

всегда пишу комментарии без кода

всегда

с учетом документации в тикетах и вики коментариев больше чем кода

комментирование для хорошего программиста аналогично написанию кода - происходит всегда

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

Никогда. Считаю тех, кто это делает говном.

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

Комментирую только общие моменты ("в этом файле/классе сделан показ жопы"), хаки и небольшие TODO/FIXME.

> как часто вы пишете код без комментариев?

очень часто ибо сам запутываюсь :)

>хаки

быдлокодер ?

> код не писал, но если бы писал, комментировал бы

А я вот царем не был, но если бы был, то всем подданным раздавал бы конфеты бесплатно.

Забери их всех в себя!

Ясен пень, а как по-другому. Тем более перекрестный код-ревьювинг, коллеги не дадут шлак закоммитить.

> быдлокодер ?

А то ж.

Хеллоуворлдщик?

Пока не писал то, что возможно будут копать другие, точнее не выпустил. Но в целом схема обычна такая: пишу код с коментариями, коментируя в основном то, что не понятно с первого взгляда. Ну и функции, структуры и тд, по минимому. Потом, когда дописываю до некоторой круглой версии(обычно маленькой) пробегаюсь и чищу комменты, добавляю.
Теперь вот пишу несколько маленьких проектов, которые может быть выпущу(если будет не стыдно показать), так вот планирую на основе сгенериованных доков doxygen - доработать более полноценные доки. Хотелось бы чтобы это стало привычкой для меня.

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

Кстати, кто на каком языке комментирует? Я раньше писал на инглише, потом как-то незаметно перешел на русский.

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

Кстати, кто на каком языке комментирует?

Помесь русского, хохляцкого и словечек и литературы золотого века.

Очень часто. Бывает когда только начинаю проект, пишу комменты, а потом начинаю забывать про них.

Я даже в екселе таблички комментирую и других заставляю.

А я и есть тот самый код, который пишет меня с комментариями

Пишу комментарии для себя (т.е. представляю что я читал бы этот код, и где это было бы мне непонятно - пишу комментарии). Т.к. я код люблю читать больше чем комментарии, их у меня обычно ужасающе мало. Ещё я по-английски пишу неграмотно, по-русски коммментарии писать не могу принципиально, поэтому писать их не люблю :)

Код на лиспе является самодокументирующимся. Ставлю комменты лишь в тех случаях, когда выбор того или иного решения с первого взгляда непонятен.

запускаешь код и он сначала пишет талмуд с документацией о себе, а потом выполняет что требуется?

>Хеллоуворлдщик?

Не понял сарказм ?

В Лиспе не принято чрезмерно сокращать слова, поэтому текст программы выглядит вполне литературно. В отличие от Хаскелля. Или, например, взять макрос LOOP:

(loop for item in items
  when (odd item)
    collect item)

Скажите мне, что это не Шекспир писал :)

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

> кто на каком языке комментирует?

Помесь английского и русского. Русский - тогда, когда не хватает английских слов, чтобы выразить своё отношение к тому, что пишу, а также тогда, когда знаю, что зарубежным коллегам никогда не придётся лезть в этот код. Иначе они пожалеют, что не знают русского :)

Комеентирую каждую функцию, но пиши скорее ТЗ на неё, то есть что она должна делать. А как это работает - нафиг. В редких случаях ссылку на алгоритм или пояснение чего-то неочевидного.

Комментирую только то, что не совсем очевидно при беглом просмотре.

Комментирую только неоднозначные решения. Недописаные реализации.

Самые популярные коментарии:

/* NOT IMPLEMENTED */

/* TODO: bah bah bah */

/* TODO: bah bah bah */

$ grep -r '//TODO:' ~/work/programming/php/bors|sed -sr 's#^.*//TODO: # - #g'|sort -u

 - need best method
 - need make stat cache clean by news change.
 - workaround странной ошибки на страницах вида http://balancer.ru/user/29251/aliases.html
 - wtf??
 - АвиаПортовская заглушка
 - Вычистить все _queries.
 - Заглушка для скипания левых полей редактора.
 - Потенциальная уязвимость в безопасности - пользователь может создать новую страницу,
 - Реализовать статическое кеширование файлов, отличных от index.html / text/html
 - Сделать автоочистку привязок к несуществующим объектам. В первую очередь - aviaport_images
 - Сделать проверку на привязку к галерее. А то сейчас можно смотреть любую картинку.
 - а вот это теперь, наверное, можно будет снести благодаря {if(empty($vhost_data) && $host == $_SERVER['HTTP_HOST'])} ...
 - а нужен ли этот файл?
 - в будущем обрать прехэндрер страниц.
 - в будущем снести вторые вызовы.
 - в старом коде сделать замены:
 - временный костыль, чтобы не грузился при повторных запросах объекта этот же самый класс.
 - вынести в модули "Обратите внимание" и т.п.
 - грязный хак
 - добавить access
 - добавить поиск по aviafirms_synonyms!
 - добавить проверку на авторизацию
 - заглушка для старых проектов
 - затычка!
 - заюзать make_input_time? (funcs/datetime.php)
 - исправить!!
 - костыль!
 - мегакостыль!
 - медленно на больших текстах.
 - на время отладки
 - не используется? *}
 - не утягиваем, пока нет места на винте.
 - оптимизировать!
 - оставить только это
 - отловить кеш-запись постов при добавлении нового сообщения. (class_id = 1)
 - перекинуть в bors-core после обновления оного на АвиаПорте.
 - подумать на тему неполной чистки.
 - поменять все вложенные вызовы на один предобработчик
 - поменять на type_id
 - поставить ловушку
 - поставить проверку на отсутствующие изображения
 - придумать обработку больших картинок.
 - проверить!
 - проверка!
 - продумать систему контроля типов.
 - разбивка по страницам.
 - редирект
 - сделать вариант, совместимый с safe_mod!
 - сделать отброс пробельных символов
 - сделать отброс также \r
 - сделать проверку на наличие активного кода в стилях.
 - сделать редирект /rubric/ на главную авиапредприятий
 - снести, заглушка
 - странно, при прямом вызове пропадают флаги.
 - тут гости у нас строго 3-я группа!
 - убрать user_id и user_name в старых шаблонах.
 - убрать после обновления! Чтобы не терялись пометки is_disabled.
 - ужасно, но пока только так.
 - это хак! сперва должны прописываться begin_time, потом - ttl!

:)

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

>как часто вы пишете код без комментариев?

Всегда.

Просто используй нормальный редактор/IDE, где комментарии, и вообще любые логические блоки можно сворачивать.

>всегда пишу комментарии без кода

такая-же байда

когда зол.

Сначала не пишу, потому что ощущаю себя К.О. (do_damage # Causes damage), а потом начинаю входить во вкус и всё остальное тоже кажется слишком очевидным…

Аналогично. Правда щас пытаюсь заставить себя ставить комменты хотябы там где по моему мне самому не понятно как работает то что написал. Такими комментариями я сам себе пытаюсь объяснить как это работает.

всегда пишу комментарии в .h, в .с/.cpp - в зависимости от сложности

Десятистрочным шелл-скриптам и авковским однострочникам комментарии не очень-то и нужны...

Пишу комментарии всегда.

> копаю плагин к вордпрессу. на 1м этапе приходится разбираться как что работает и самому ставить комментарии

Хорошие комментарии -- не меньшее искусство, чем хороший код. А может даже и большее, потому что при комментировании нужно уметь посмотреть на код со стороны, критически оценить логику и дать исчерпывающее, но в то же время лаконичное объяснение. Тут нужен своего рода литературный талант (привет, ГСМ!). К сожалению, кодеры редко обладают таким талантом. Впрочем, после того, как я принимал лабы у студентов, меня сложно напугать.

> Десятистрочным шелл-скриптам и авковским однострочникам комментарии не очень-то и нужны...

Почему-то вспомнился однострочник на Перле. :)

Осиль уже наконец. Как ты выражаешься "кодеры" не пишут комментарии не от хорошей жизни. Если бы у меня было время, это поощрялось, это требовалось - я тоже лепил бы комментарии направо и налево.

Написание качественной документации - это отдельный этап в разработке ПО. А те косматые заметки, которые оставляют на полях месные быдлоговнокодеры мня из себя тру девелоперов - это намордник на их собственную совесть не больше и не меньше.

> Как ты выражаешься "кодеры" не пишут комментарии не от хорошей жизни. Если бы у меня было время, это поощрялось, это требовалось - я тоже лепил бы комментарии направо и налево.

Люди вообще работают не от хорошей жизни. Вот было б у меня много денег -- я бы точно не работал. :)

> Написание качественной документации - это отдельный этап в разработке ПО.

Это в теории. На практике ни разу такого не видел, хотя допускаю что где-нибудь в Лапландии живет Санта-Клаус и манагеры-идеалисты.

не пишу комментарии. мне всегда кажется, что после их написания код становится менее читаемым.