Комментируете ли вы свой код?

Код нужно обязательно комментировать, но обычно на это не хватает времени и сил. В принципе, когда времени нет я обхожусь минимумом - делаю только комментарии над функциями (для чего она, что выводит) и объясняю всякие нестандартные вещи типа $b = true; if (strlen($b) < 5) {}

Практически не каментирую. Только если клиент просить.
Иногда для себя каменты втискиваю +)

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

Когда как. если проект серьёзный обязательно. вернёшься к нему через года 2 -будто другой писал. по камментам смотришь что где

В каждом файле вверху имя проекта, назначение модуля, дата создания и разработчик.

Каждая функция документируется в заголовке. Что делает и какие параметры принимает (если по названию параметров неясно).

Блочные комментарии по тексту(этот блок делает то-то) и в особо тяжелых местах по необходимости.

Понимание необходимости комментировать всё что только возможно приходит после нескольких лет работы над проектом, когда сотни тысяч строк написанного годы назад кода забылись, забылись причины выбора конкретного алгоритма и многое другое, когда надо обеспечить возможность правки кода другим программистом... 50% текста программы - комментарии. Ещё 200-300% - тесты. Вот так нормально будет

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

+ ко всему я сторонник довольно длинных имен идентификаторов, которые многое говорят сами за себя.

Комментирую всегда если:
Пишу для заказчика, Пишу больше приложение которое привышает больше 10 000 строк

Цитата ("DEM90"):

Раньше, когда скрипты писались небольшие (не выше 300-500 строчек), не комментировал... разобраться после недели было сложновато, но всё же было лень писать.. теперь стараюсь комментировать ВСЁ, любую строчку, а например переменную $ua всегда сначало комментирую "//USER ARRAY - массив пользователя", стало намного легче потом добавлять код )))

мне кажется что намного логичнее (и экономичнее) было бы назвать переменную $userArray и не писать ненужных комментариев

Цитата ("caezar"):

мне кажется что намного логичнее (и экономичнее) было бы назвать переменную $userArray и не писать ненужных комментариев

Логичнее было бы написать комментарий (ИМХО)

//USER ARRAY - массив пользователя, используется для хранения информации о пользователях

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

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

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

Считаю это хорошим тоном, но и страюсь не писать лишних коментариев.

Всегда комментирую(ем). Это уже привычка. Даже потом свой код неловко читать некомменченным))

Чувствую дискомфорт если класс или метод не покрыт комментами в стиле Javadoc

Вообще-то я теперь пишу только на bash и только для себя
Комментирую всё, только на English'е и в разработанном мною же формате. Часто переписываю скрипты, чтобы упростить и 'синхронизировать' с остальными, поэтому структурированные комменты необходимы.

Только для себя, когда размещяю в нет убираю обязательно. Все равно с коментами легче

Цитата ("flashripper"):

Только для себя, когда размещяю в нет убираю обязательно. Все равно с коментами легче

А зачем ты в нете код размещаешь? :shok: Флеш же скомпилированный, какие коменты?

Стараюсь комментировать всё ! :huh:<_<
Потом удобней разбираться, что, где, и.т.д.

Я коментирую код в самом нужном месте и только для себя. Когда гружу на сайт коменты убираю. На прописание коментов также уходит лишнее время