Применение искинов - шоссе империализма (Стенгазета русификаторов ИТ)

Информация о пользователе

Привет, Гость! Войдите или зарегистрируйтесь.



Принцип разделения кода и документации

Сообщений 1 страница 4 из 4

1

БудДен написал(а):

Учитывая, что сейчас все пользуются системами автогенерации документации, как раз в исходниках комментариев должно быть очень много.

Тут фактические ошибки:
1) у всех есть возможность пользоваться системами, но не у всех есть желание
2) могут быть такие системы документации, которые связывают файлы с документацией с кодом и не требуют размещения документации в коде.
(это аналогично концепции CodeBehind для web-страниц)

БудДен написал(а):

отдельно хранящаяся документация устареет тем более

Это всего лишь означает, что система документации была интегрирована в процесс сборки,
но не была интегрирована в процесс разработки (редактирования в IDE)

БудДен написал(а):

становится отдельной проблемой найти документацию, соответствующую определённой версии исходника.

Это означает, что система документирования не проинтегрирована в достаточной мере с системой контроля версий исходного кода.
(т.е. учитываются версии документации, но не их связь с версиями исходного кода).
Хотя казалось бы, достаточно, чтобы файлы с описанием кода хранились в той же ветке репозитория, что и код
(чтобы метка версии действовала одновременно на код и документацию).
В принципе, можно допустить доработку документации после простановки метки версии, но тогда надо уже с ветками активнее работать.
Т.е. ветка кода соответствует какому-то релизу, и в неё складывается доработанная документация по этой версии.

БудДен написал(а):

Т.е. лучшего места для хранения документации, чем исходник, я не могу себе представить.

Слабая фантазия. Так мы технологический прорыв не совершим.

Отредактировано Лис (2021-01-08 13:59:48)

0

2

«является основой для коммерческих продуктов, можно заподозрить, что скудость комментариев в нём не случайна»

Ну это давно так, выполняемые файлы тоже отделяют от файлов с символами, необходимыми для отладки.

0

3

Не знаю, в том, что я наблюдаю, стараются пользоваться автогенерацией. В нашем проекте на работе исторически сложилось, что документация находится в вики в трекере - это довольно плохо, т.к. отсутствует связь. А часть - ещё хуже, находится в файловом хранилище. Чтобы была какая-то система документирования, интегрированная в IDE - ну, я такого не видел, хотя представить себе могу. Хотя я редко меняю работу, может, просто не попалось. Думаю, тут дело не в отсутствии фантазии у меня, а в том, что я предпочитаю простые решения.

Отредактировано БудДен (2021-01-08 21:01:45)

0

4

см. также.
Теория автоматов (комментарий про документацию).

Отредактировано Лис (2024-09-17 11:09:11)

0