Учитывая, что сейчас все пользуются системами автогенерации документации, как раз в исходниках комментариев должно быть очень много.
Тут фактические ошибки:
1) у всех есть возможность пользоваться системами, но не у всех есть желание
2) могут быть такие системы документации, которые связывают файлы с документацией с кодом и не требуют размещения документации в коде.
(это аналогично концепции CodeBehind для web-страниц)
отдельно хранящаяся документация устареет тем более
Это всего лишь означает, что система документации была интегрирована в процесс сборки,
но не была интегрирована в процесс разработки (редактирования в IDE)
становится отдельной проблемой найти документацию, соответствующую определённой версии исходника.
Это означает, что система документирования не проинтегрирована в достаточной мере с системой контроля версий исходного кода.
(т.е. учитываются версии документации, но не их связь с версиями исходного кода).
Хотя казалось бы, достаточно, чтобы файлы с описанием кода хранились в той же ветке репозитория, что и код
(чтобы метка версии действовала одновременно на код и документацию).
В принципе, можно допустить доработку документации после простановки метки версии, но тогда надо уже с ветками активнее работать.
Т.е. ветка кода соответствует какому-то релизу, и в неё складывается доработанная документация по этой версии.
Т.е. лучшего места для хранения документации, чем исходник, я не могу себе представить.
Слабая фантазия. Так мы технологический прорыв не совершим.
Отредактировано Лис (2021-01-08 13:59:48)