Нужно ли документировать код?
От: Патрик  
Дата: 06.07.05 09:01
Оценка: 6 (1)
Что уважаемая общественность думает о необходимости документировать/комментировать код?

Я смотрю, что мнения на этот счёт радикально расходятся

Тут говорят что документировать/комментировать надо:
Re: Есть ли в природе каталогизатор С++ кода...?
Автор: Андрей Коростелев
Дата: 03.07.05

Re[3]: Есть ли в природе каталогизатор С++ кода...?
Автор: bkat
Дата: 02.07.05

Re[5]: Есть ли в природе каталогизатор С++ кода...?
Автор: eao197
Дата: 02.07.05


Например тут — наоборот
http://www.rsdn.ru/Forum/?mid=923441
Автор:
Дата: 30.11.04

http://www.rsdn.ru/Forum/?mid=923441
Автор:
Дата: 30.11.04


Сам я придерживаюсь мнения о том, что во многом наличие/отсутствие документации зависит от культуры организации. В некоторых организациях знания хранятся в головах у сотрудников, в некоторых — в документах ворда. И я лично, плохого в этом не виду ничего.

Например наш проект, средний по размеру (~40 человеко/лет) пережил уже несколько версий, частично сменилась команда которая над ним работает и при всё при этом документации по нему по сути нет никакой, ни по архитектуре, ни по коду. Комментариев в коде нет тоже. И проблем это не вызывает. Обратите внимание, я не говорю что это круто — я лишь говорю, что нам это не доставляет никаких проблем. А если нет разницы — зачем платить больше? (с)

Поэтому, во многом, вопрос к тем кто практикует документирование — а зачем вам это? Что, собственно, вам дают залежи документации? Кто её читает? Или она нужно только для того, что бы унять какие-то страхи менеджмента? Так для этого есть более совершенные методы.
... << RSDN@Home 1.1.3 stable >>
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.