共用方式為


Documentation 項目 (CSDL)

概念結構定義語言 (CSDL) 中的 Documentation 項目可提供與父項目中定義之物件有關的資訊。在 .edmx 檔案中,當 Documentation 項目為項目的子系,同時成為實體資料模型設計工具設計介面上的物件 (例如實體、關聯或屬性) 時,Documentation 項目的內容會出現在該物件的 Visual Studio [屬性] 視窗中。

Documentation 項目可以擁有下列子項目 (依列出的順序):

  • Summary:父項目的簡短描述。(零或一個項目)

  • LongDescription:父項目的詳細描述。(零或一個項目)

  • Annotation 項目.(零或多個項目)

適用屬性

可以將任何數量的註釋屬性 (自訂 XML 屬性) 套用至 Documentation 項目。不過,自訂屬性不可屬於任何 XML 命名空間,這是保留供 CSDL 使用。任兩個自訂屬性的完整名稱不能相同。

範例

下列範例示範 Documentation 項目 (為 EntityType 項目的子項目)。如果下方的程式碼片段位於 .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>

請參閱

概念

Entity Framework 概觀

CSDL 規格

EntityContainer 項目 (CSDL)

.edmx File Overview

其他資源

CSDL、SSDL 和 MSL 規格

ADO.NET Entity Data Model Tools