Документирование неполного графа объекта объекта DTO

Question

Текущая архитектура основана на службах WCF, которые заполняют объекты DTO из базы данных и возвращают их.

Некоторые методы возвращают полный граф объектов, некоторые только частичные. Если полностью заполнено, некоторые графы объектов будут чрезвычайно большими - так что это не вариант для всех случаев.

Как документировать, какие свойства объекта DTO из многих заполнены, а какие нет? Это магазин .NET и комментарии XML не обеспечивают достаточной гибкости для документирования не всегда заполненных свойств. Как другие справляются с этой задачей?

Ех: К клиенту объект-счет-фактура одинаков, имеет ли он все свойства, заполненные или нет.

Одна из предложенных идей заключается в создании схемы XSD для объекта с только заполненными свойствами. Это не похоже на «хорошую/полезную» документацию, хотя технически правильную.

EDIT: Я обнаружил, что UML может быть лучшей альтернативой, чем XSD, поскольку это более читаемо. Есть ли быстрый способ перейти от XML -> XSD -> UML (или другой парадигмы диаграмм)?

Answer 1

В одной из наших систем мы фактически используем 2 модели: одна внутренняя, полная и зрелая, другая используется в таких сервисах, как контракт между нашей системой и внешними сторонами. мы создали автогенераторы и наполнители. Это дало нам возможность изменить наше внутреннее представление и структуру объектной модели, не нарушая контракт данных внешних систем.