CSDLを使用してエンティティを文書化する

CSDLには、エンティティを文書化するためにaccording to MSDNという文書/要約および文書/ LongDescriptionが含まれています。これらの要素の内容はエンティティデザインサーフェスのプロパティウィンドウに表示されるので、エンティティを扱う際にこれらのフィールドにいくつかのメモを書き込むことは簡単です。CSDLを使用してエンティティを文書化する

EDMXファイルはXMLであるため、XSLTスタイルシートを記述して、これらの要素からドキュメントを取得するのは簡単です。これを行うための標準的なツールはありますか？ CSDLドキュメンテーションフィールドを使用する利点はありますか？これらのフィールドを使用している人は誰ですか、もしそうなら、エンティティを文書化するのに効果的な方法であると感じましたか？

出典

2010-12-29 Paul Keister

CSDLに格納されたドキュメントデータは、生成されたコードでXMLドキュメントのコメントとして発行されます。その結果、それが自動的にVisual Studioでインテリセンスのツールチップに表示されます。

alt text

あなたはより正式な文書化のためにそれを使用したい場合は、SandCastleを使用することができます（必要に応じて一緒に優れたフロントエンドSHFB付き）、またはWindowsのヘルプファイルを作成するためのいくつかの他のXml DocComment抽出ツールや、ドキュメンテーションを含むWebサイトのヘルプ。

データベースがドキュメントを使用して文書化されている場合は、SQL Serverの属性は、データベースからそのドキュメントを抽出し、このツールを使用してSSDLとCSDLコメント取り込むことができます。http://huagati.com/edmxtools/

出典

2010-12-30 08:14:05 KristoferA

感謝を！以前はSandCastleを使用していましたが、この情報によってドキュメンテーションフィールドがパースペクティブに表示されます。 –

CSDLを使用してエンティティを文書化する

答えて

関連する問題