Documentation 要素 (CSDL)
概念スキーマ定義言語 (CSDL) の Documentation 要素は、親要素で定義されたオブジェクトに関する情報の提供に使用できます。.edmx ファイルでは、Documentation 要素が、Entity Data Model デザイナーのデザイン画面にオブジェクト (エンティティ、アソシエーション、プロパティなど) として表示される要素の子である場合、Documentation 要素の内容がそのオブジェクトの Visual Studio [プロパティ] ウィンドウに表示されます。
Documentation 要素には、次の子要素をここに示す順序で含めることができます。
Summary: 親要素の簡単な説明 (0 個または 1 個の要素)。
LongDescription: 親要素の詳細な説明 (0 個または 1 個の要素)。
annotation 要素(0 個以上の要素)。
適用可能な属性
Documentation 要素には、任意の数の annotation 属性 (カスタム XML 属性) を適用できます。ただし、カスタム属性は CSDL 用に予約されたどの XML 名前空間にも属さない場合があります。カスタム属性の完全修飾名は一意である必要があります。
例
次の例では、EntityType 要素の子としての Documentation 要素を示しています。次のスニペットが .edmx ファイルの CSDL の内容に含まれていた場合、Customer エンティティ型をクリックすると、Summary 要素と LongDescription 要素の内容が、Visual Studio [プロパティ] ウィンドウに表示されます。
<EntityType Name="Customer">
<Documentation>
<Summary>Summary here.</Summary>
<LongDescription>Long description here.</LongDescription>
</Documentation>
<Key>
<PropertyRef Name="CustomerId" />
</Key>
<Property Type="Int32" Name="CustomerId" Nullable="false" />
<Property Type="String" Name="Name" Nullable="false" />
</EntityType>