ГлавнаяПрограммирование › Зачем комментировать код

Зачем комментировать код

Сегодня я окончательно поняла для себя зачем нужно документировать свой код. Вот программила и горя не знала (ну в своем-то коде не заблудишься вроде) пока жареный петух в жопу не клюнул и не потребовалось срочно накропать техдокументацию к проекту. Вот тут-то я и поняла это он - пиздец.
В общем подумав с пару минут меня посетила гениальная мысль - сто пудов уже кто-то эту фигню автоматизировал. Полминуты поиска и чудеснейшая приблуда под названием Doxygen найдена, скачана и даже уже сгенерировала документацию по проекту в формате html. В общем классный пакет для этого дела.
НО! Документацию генерирует на основании комментариев к коду, коих у меня полторы штуки на пару тысяч строк кода. Вот и сижу как дура - пишу комментарии ко всему проекту...
Вывод: господа програмеры - документируйте свою писанину сразу и да не постигнет вас такой облом :laugh:

Отзывы

Павел Моценко 01.04.11 10:22
Когда карябаю свой код пишу комметы чуть ли ни к каждой строчке.  laugh
//Сначала начал писать от того, что узнал как это сделать  rofl
Потом когда что-то спиздиш из чужого скрипта, чтоб не забыть...
А теперь наверное по привычке, и для себя удобно, я обычно занимаюсь всякой хренью по
немного поэтому мне важно искать нужный кусок, так дольше канечно...
Николай Моценко 01.04.11 12:29
ага, тежело каментить но легко сдавать)))))))
vrang 03.04.11 07:40
эх, хорошо тебе :)
а я вот обленилась как сволочь - теперь полтора дня придется беллетристикой заниматься
vrang 03.04.11 07:41
та да  laugh
Чтобы оставить отзыв авторизируйтесь на блоге или войдите через социальную сеть
© Харьковблог - блог города Харькова
Напишите нам
create by motsenko.com
Харьковблог в