現在のアーキテクチャは、DB から DTO オブジェクトを設定して返す WCF サービスに基づいています。
一部のメソッドは完全なオブジェクト グラフを返しますが、一部のメソッドは部分的なグラフのみを返します。完全に移入された場合、一部のオブジェクト グラフは非常に大きくなります。そのため、すべてのケースに対応できるわけではありません。
多くのDTOオブジェクトのプロパティのうち、どのプロパティが入力され、どのプロパティが入力されていないかを文書化する方法は? これは .NET ショップであり、XML コメントは、常に入力されるとは限らないプロパティを文書化するのに十分な柔軟性を提供しません。他の人はこの課題にどのように取り組んでいますか?
例: クライアントにとって、Invoice オブジェクトは、すべてのプロパティが入力されているかどうかに関係なく同じです。
提案されている 1 つのアイデアは、入力されたプロパティのみを使用してオブジェクトの XSD スキーマを生成することです。技術的には正しいですが、これは「良い/使える」ドキュメントのようには見えません。
編集:UMLの方が読みやすいため、XSDよりも優れた代替手段である可能性があることがわかりました。XML -> XSD -> UML (または別の作図パラダイム) に簡単に移行する方法はありますか?