Deutsch
Germany.ruФорумы → Архив Досок→ Программирование

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

01.08.18 09:58
Re: Платформа для документации
 
Murr_0001 знакомое лицо
Murr_0001

надо код комментировать и на основе комментариев генерировать документацию для разработчиков

------

Комментировать - надо.

Но! комментарии к коду не заменяют документацию для разработчика.


Сейчас вот ковыряю старый ВБ6-лике код.

Работает он так:

- с сервера грузится куча данных

- из данных производится подвыборка по ордерам

- из подвыборки производится еще подвыборка - по штукам

- снова подвыборка по критериям, пока не останется что-то, что знают как обсчитать.

Все это размазано где-то на 14-15.000 строк. Работает - минут 40...

Можно все это безобразие аккуратно прокомментировать, но занятие - совершенно бессмысленное.

Дело в том, что добавить туда что-то или поменять там что-то - невозможно - ни с комментариями, ни без них. ВБ6-лике.

Однако все это можно заменить всего лишь двойным циклом - 10-15 строками - и отдельными

методами обсчета для каждой единицы наличного оборудования.

Получится достаточно просто и сопровождаемо.

Но для этого - нужна дока в которой написано не как (комментарии) оно считается,

а что (тех.требования) там пытаются посчитать.

 

Перейти на