Documentation (Elemento) (SSDL)

El elemento Documentation del lenguaje de definición de esquemas de almacenamiento (SSDL) se puede usar para proporcionar información sobre un objeto definido en un elemento primario.

El elemento Documentation puede tener los elementos secundarios siguientes (en el orden mostrado):

• Summary: una descripción breve del elemento primario. (cero o un elemento).

• LongDescription: una descripción extensa del elemento primario. (cero o un elemento).

Atributos aplicables

Se puede aplicar cualquier número de atributos de anotación (atributos XML personalizados) al elemento Documentation. Sin embargo, es posible que los atributos personalizados no pertenezcan a ningún espacio de nombres XML reservado para CSDL. Dos atributos personalizados cualesquiera no pueden tener nombres completos idénticos.

Ejemplo

En el ejemplo siguiente se muestra el elemento Documentation como un elemento secundario de un elemento 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>

Vea también

Conceptos

Información general de Entity Framework
Especificación SSDL

Otros recursos

Especificaciones CSDL, SSDL y MSL
ADO.NET Entity Data Model Tools