UML и документирование длинных методов

Question

Я использую UML для документирования частей старой программы на С ++.Это только часть кода, но его документирование сделало меня безумным, так как даже этот процесс довольно большой.До сих пор я использовал диаграммы классов для соответствующего кода, а также некоторые действия и последовательности, где это необходимо.

Мой вопрос заключается в том, что я считаю, что то, что я сделал до сих пор, хорошо для всей документации, но я хочу перейти кгрязные детали нескольких методов и один из них длиной 202 строки, что я должен использовать для этого?Диаграмма или последовательность действий?

Я использую Visio для документации по UML.

Спасибо.

Answer 1

Вопрос: хотите ли вы описать процесс или взаимодействия между объектами, которые выполняются этими несколькими методами?Процесс можно разбить на выполняемые действия, их состав и поток данных.Взаимодействия состоят из сообщений, отправляемых между объектами.

Answer 2

Ну,

Краткий ответ:

Если вы хотите задокументировать алгоритм (который используется одним из методов вашего системного объекта ^ s): Используйте диаграммы активности.

Длинный ответ:

По моему опыту, документация UML - худшая.

Люди обычно используют Uml Tools, которые автоматически восстанавливают код инженера в Uml (обычно это диаграммы классов, а иногда и диаграммы последовательностей), и диаграммы, которые автоматически генерируются, обычно содержат много деталей, а иногда и бессмыслицу.

В качестве совета " Правильно комментируйте ваш код " и используйте такие инструменты, как Doxygen .Они лучше подходят для Code Documentation.

Но вы можете использовать UML для Document Architect Document . [SAD].Крэйг Ларман имеет хороший раздел и пример этого в своих книгах о Документирование архитектуры

Мотивация: зачем создавать SAD? Когда кто-то присоединяется к команде разработчиков,будет полезно, если тренер проекта скажет: «Добро пожаловать в проект NextGen! Пожалуйста, зайдите на сайт проекта и прочитайте SAD на десять страниц, чтобы получить представление о больших идеях».А позже, во время последующего выпуска, когда в системе работают новые люди, SAD может стать учебным пособием для ускорения их понимания.

Следовательно, его следует писать с учетом этой аудитории и цели: что делатьМне нужно сказать (и нарисовать в UML), что быстро поможет кому-то понять основные идеи в этой системе?[ Применение UML и шаблонов, третье издание, Крейг Ларман] [Глава 39. Архитектура документирования: UML и модель представления N + 1]

Answer 3

Эмпирическое правило может заключаться в том, что если кажется, что есть несколько агентов, передающих поток между собой, используйте последовательность;в противном случае, активность.В одной функции активность, вероятно, лучше всего - но не обязательно.

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

Является ли разделение функции опцией?