Documentation 元素 (CSDL)

以概念架构定义语言 (CSDL) 表示的 Documentation 元素可用于提供有关在父元素中定义的对象的信息。 在 .edmx 文件中，当 Documentation 元素为在实体数据模型设计器的设计图面上显示为对象（如实体、关联或属性）的元素的子元素时，Documentation 元素的内容将显示在该对象的 Visual Studio 的**“属性”**窗口中。

Documentation 元素可以具有以下子元素（按所列顺序）：

• Summary：有关父元素的简短说明。 （零个或一个元素）

• LongDescription：有关父元素的详细说明。 （零个或一个元素）

• 批注元素. （零个或多个元素）

适用的特性

可以将任何数量的批注特性（自定义 XML 特性）应用于 Documentation 元素。 然而，自定义特性可能不属于为 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>

另请参见

概念

实体框架概述
CSDL 规范
EntityContainer 元素 (CSDL)

其他资源

CSDL、SSDL 和 MSL 规范
ADO.NET Entity Data Model Tools
.edmx File Overview