May 7, 2009

Документировано-прекрасное.

Несколько дней назад, попалась статья на тему бесполезности документирования программного кода (не могу найти). Стараясь не участвовать в «священных войнах», отмечу, что приводились вполне разумные доводы и примеры из жизни. Выдержанная статья. И особо возразить нечего было. А теперь есть.

Два дня трудился над разбором чужого кода. Причем какого! Включая всю самокритику, на которую способен, и осознавая, что порой излишне требователен, даже привередлив. А так же, прилюдно признаваясь, что я злой человек, не добрый - пусть так будет. Так вот, после всех моих покаяний, продолжаю: дерьмо программа, код кусок грязи, а авторы…

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