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

Статья
02/28/2011

Элемент Documentation в языке CSDL может использоваться для предоставления сведений об объекте, который определен в родительском элементе. В EDMX-файле, если элемент Documentation является дочерним по отношению к элементу, который появляется в качестве объекта в области конструктора EDM (такого как сущность, ассоциация или свойство), содержимое элемента Documentation появляется в окне Visual Studio Свойства для объекта.

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

Summary. Краткое описание родительского элемента. (ноль или один элемент)
LongDescription. Подробное описание родительского элемента. (ноль или один элемент)
Элементы Annotation. (ноль или больше элементов)

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

К элементу Documentation может быть применено любое количество атрибутов annotation (настраиваемых атрибутов XML). Однако настраиваемые атрибуты не могут принадлежать к любому пространству имен XML, зарезервированному для CSDL. Полные имена любых двух настраиваемых атрибутов не могут совпадать.

Пример

В следующем примере показан элемент Documentation в качестве дочернего элемента для элемента EntityType. Если бы приведенный ниже фрагмент был включен в содержимое EDMX-файла на языке CSDL, то содержимое элементов Summary и LongDescription появилось бы в окне Visual Studio Свойства при выборе типа сущности Customer.

<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)

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

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

Поделиться через