Documentation 項目 (SSDL)

儲存結構定義語言 (SSDL) 中的 Documentation 項目可提供與父項目中定義之物件有關的資訊。

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

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

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

適用屬性

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

範例

下列範例示範的 Documentation 項目為 EntityType 項目的子項目。

<EntityType Name="Customers">
  <Documentation>
    <Summary>Summary here.</Summary>
    <LongDescription>Long description here.</LongDescription>
  </Documentation>
  <Key>
    <PropertyRef Name="CustomerId" />
  </Key>
  <Property Name="CustomerId" Type="int" Nullable="false" />
  <Property Name="Name" Type="nvarchar(max)" Nullable="false" />
</EntityType>

<EntityType Name="Customers">
  <Documentation>
    <Summary>Summary here.</Summary>
    <LongDescription>Long description here.</LongDescription>
  </Documentation>
  <Key>
    <PropertyRef Name="CustomerId" />
  </Key>
  <Property Name="CustomerId" Type="int" Nullable="false" />
  <Property Name="Name" Type="nvarchar(max)" Nullable="false" />
</EntityType>

<EntityType Name="Customers">
  <Documentation>
    <Summary>Summary here.</Summary>
    <LongDescription>Long description here.</LongDescription>
  </Documentation>
  <Key>
    <PropertyRef Name="CustomerId" />
  </Key>
  <Property Name="CustomerId" Type="int" Nullable="false" />
  <Property Name="Name" Type="nvarchar(max)" Nullable="false" />
</EntityType>

請參閱

概念

Entity Framework 概觀

SSDL 規格

其他資源

CSDL、SSDL 和 MSL 規格

ADO.NET Entity Data Model Tools