В копилку программистских грехов

[vit_r]

Плох не тот, кто невнятные комменты пишет.
И не тот, кто меняет код, позабыв комменты исправить.

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

Comments

[alll]

Именно поэтому комментариев в коде быть не должно. ;)

[vit-r.livejournal.com]

Такое видел только в совершенно ужасном коде от какого-то профессора, который прокомментировал "Тут все с высшим образованием. Как-нибудь разберутся"

[alll]

> какого-то профессора, который прокомментировал

Вот не надо было ему комментировать, ой не надо. ;)

[vit-r.livejournal.com]

Это был ответ на мой вопрос "а не стрёмно ли?"

[alll]

Надеюсь, после такого ответа он остался жив. :) Но лучше бы промолчал. Т.е. см. выше. :)

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

[alll]

Подозреваю, что если бы он этот ужасный код ещё и комментировал с присущим ему качеством, то стало бы только хуже. ;)

[vit-r.livejournal.com]

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

[alll]

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

[alexott.livejournal.com]

совсем? даже отсылок к описаниям форматов данных/алгоритмов?

[alll]

Отсылки к соответствующим местам документации - сами имена функций.
Как вариант - doxigen-style, к самой функции присобачивается соответствующий кусок документации.

[alexott.livejournal.com]

ну вот пишу я конвертер MS PPT, у меня через каждые 5-10 строк, отсылка к конкретному описанию структуры в официальной документации - иначе я через 2 месяца уже сойду с ума, пытаясь восстановить как это дело работает, если не буду пользоваться комментариями