Недавно мне поручили подробно документировать часть устаревшей программной системы, выполняющей сложные операции построения строк. Логика в основном находится в одном классе, около 3000 строк кода спагетти-шаблона.
Основная цель документации - помочь поддержке уровня 1-2 решить проблемы/вопросы, которые немного немного глубже и освободить ресурсы разработчиков.
Я ни в коем случае не являюсь экспертом в документировании, поэтому мой вопрос: существует ли стратегия или принципы, которым я могу следовать при документировании неструктурированного кода? Можно ли вообще выполнить эту задачу удовлетворительным образом? (Я подумываю о том, чтобы порекомендовать рефакторинг, но я новичок в компании)
Я начал с блок-схемы, но из-за бесчисленных операторов if это довольно быстро и добротно стало сбивать с толку. извратил свою собственную цель, не дав хорошего обзора.
Я провел некоторое исследование, но в основном я нашел информацию о том, как избежать неструктурированного кода или как документировать хорошо структурированное программное обеспечение.< /п>
Подробнее здесь: https://stackoverflow.com/questions/789 ... -like-code
