Comments / Docs
Sep. 26th, 2011 09:59 pmЕсли по чесноку, то к комментариям я всегда относился как-то наплевательски. Программы, как правило, жили недолго, и поэтому оные содержали больше разных смехуечков, нежели четкое описание происходящего.
В очередной раз сел читать прошлогодний код. Только сейчас начал осознавать реальную ценность комментариев и документации. Ибо ни одного внятного комментария (помимо "ГДЕ БЛ#ТЬ МОЯ ДВОЙНАЯ ДИСПЕТЧЕРИЗАЦИЯ?!"), некоторые вещи просто в упор неясны и в некоторых местах откровенно присутствует чОрная магия™. В курсовой описание поверхностное, так как расплываться мыслью по древу и вдаваться в детали, коих тьма, было не люто комильфо. Отлично. Еще неделю придется потратить на разбор этого добра и добавление комментариев и написание хотя бы минимальной документации к коду (doxygen, привет).
Радует то, что, во всяком случае, не придется за месяц все это истерично делать, как в прошлом году.
В очередной раз сел читать прошлогодний код. Только сейчас начал осознавать реальную ценность комментариев и документации. Ибо ни одного внятного комментария (помимо "ГДЕ БЛ#ТЬ МОЯ ДВОЙНАЯ ДИСПЕТЧЕРИЗАЦИЯ?!"), некоторые вещи просто в упор неясны и в некоторых местах откровенно присутствует чОрная магия™. В курсовой описание поверхностное, так как расплываться мыслью по древу и вдаваться в детали, коих тьма, было не люто комильфо. Отлично. Еще неделю придется потратить на разбор этого добра и добавление комментариев и написание хотя бы минимальной документации к коду (doxygen, привет).
Радует то, что, во всяком случае, не придется за месяц все это истерично делать, как в прошлом году.