現在のアーキテクチャは、DBからDTOオブジェクトを取り込んでそれらを返すWCFサービスに基づいています。DTOオブジェクトの不完全オブジェクトグラフの文書化
いくつかのメソッドは完全なオブジェクトグラフを返します。完全に埋め込まれていると、一部のオブジェクトグラフが非常に大きくなるため、すべてのケースでオプションではありません。
多くのDTOオブジェクトのうちどのオブジェクトにどのようなプロパティが設定されているか、どのオブジェクトに設定されていないかを文書化するにはどうすればよいですか?これは.NETのショップであり、XMLコメントでは、常時入力されていないプロパティを文書化するのに十分な柔軟性はありません。他の人はこの挑戦にどのように取り組んでいますか?
例:クライアントには、すべてのプロパティが設定されているかどうかにかかわらず、Invoiceオブジェクトは同じです。
考えられる1つのアイデアは、入力されたプロパティのみを持つオブジェクトのXSDスキーマを生成することです。これは技術的には正しいものの、「良い/有用な」ドキュメントのようには見えません。
編集:私はUMLがXSDよりも優れている可能性があることを発見しました。 XML→XSD→UML(または別のダイアグラムのパラダイム)から素早く移行する方法はありますか?
これはこれを行うための「正しい」方法と思われます。私たちは、WCFでどこでも同じモデルを再利用することで、コードの重複を減らそうとしています。プロキシを作成する代わりに、クラスの再利用が可能です。そうでなければ、数十のプロキシを持ち、同じデータのサブセットを表していてもそれらの間を簡単にマッピングすることはできません。 – Leon