Не точно следуют тому, что изображено на проектных диаграммах UML

Question

Это довольно запутывало меня в течение некоторого времени. У меня есть приложение, которое уже сделано, но поскольку клиент ищет подробную документацию по нему, мне теперь нужно создавать диаграммы. Точка, в которой я так запуталась, - всякий раз, когда я делаю диаграммы, просто кажется, что диаграммы не так точно совпадают с тем, как выглядит мое кодирование. Например, на моей диаграмме классов у меня есть класс под названием «объявления», а под этим классом - метод getAnnouncements(). Но в реальном кодировании вы никогда не найдете метод, который называется getAnnoucements(), поскольку я решил не создавать для него метод и вместо этого переводить коды непосредственно в основной класс. Я знаю, что это не хорошая практика кодирования, но что, если? Итак, это мои вопросы: действительно ли мне нужно следовать тому, что находится на диаграмме классов? Или, поскольку я использую обратную инженерию, нужно ли мне следить за тем, что находится в моем коде, и создавать диаграммы?

Answer 1

Если вы делаете документацию, и вы создаете UML на уровне кода, следуйте всем, что у вас есть на самом деле.

Преимущества такого подхода в том, что

• у вас действительно есть диаграммы, похожие на код
• вы (и ваш клиент) будете способны распознавать части плохого кода (т.е. не следует различным стандарты) - как и те, которые вы описываете. Это дает возможность улучшить его в будущем.

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