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

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

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

© 2018 Харьковблог
 
Харьковблог в
разработка Idea