Элемент Documentation (язык SSDL)

  • Статья

Элемент Documentation в языке SSDL может использоваться для предоставления сведений об объекте, который определен в родительском элементе.

Элемент Documentation может иметь следующие дочерние элементы (в порядке перечисления):

  • Summary. Краткое описание родительского элемента. (ноль или один элемент)

  • LongDescription. Подробное описание родительского элемента. (ноль или один элемент)

Применимые атрибуты

К элементу Documentation может быть применено любое количество атрибутов annotation (настраиваемых атрибутов XML). Однако настраиваемые атрибуты не могут принадлежать к любому пространству имен 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>

См. также

Основные понятия

Общие сведения о платформе Entity Framework
Спецификация языка SSDL

Другие ресурсы

Спецификации языка CSDL, SSDL и MSL
ADO.NET Entity Data Model Tools