Alex B. (27.10.2008 18:19, просмотров: 136) ответил diper на ... если модуль сложный, то описание его работы расписано в шапке. Тоже касается функции. Размеры не смущают. Держится в более менее актуальном состоянии. Прелипил шапку одного модуля, текст не важен, главное количество :)
есчо раз - вы говорите про комментирование исходников. Я про документирование - т.е. про отдельный от исходников документ, который им [теоретически] соответствует. Для чего это нужно - вариантов может быть куча. Начиная с того, чтоб дать/продать партнеру объектник, заканчивая тупо требованиями конторы. В исходник вы не включите не таблицу, ни картинку. И гиперссылок у вас там тоже нет. Это абсолютно разные вещи.
C "дать объектник" мне возможно придется столкнуться совсем скоро. Сижу чешу репу. Пока понял, что "мухи отдельно, котлеты отдельно" - не тот случай. Документация должна генерироваться только из исходника. Иначе варианты "я изменил тип параметра, но забыл исправить доку" будут возникать постоянно. И хорошо если только так...
Согласуйте импеданс!