Documentation (Elemento) (CSDL)
El elemento Documentation del lenguaje de definición de esquemas conceptuales (CSDL) permite proporcionar información sobre un objeto definido en un elemento primario. En un archivo .edmx, si el elemento Documentation es un elemento secundario de un elemento que aparece como un objeto en la superficie de diseño del Entity Data Model Designer (por ejemplo, una entidad, asociación o propiedad), el contenido del elemento Documentation aparecerá en la ventana Propiedades de Visual Studio para el objeto.
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).
Elementos de anotación. (cero o más elementos).
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. Si el fragmento de código siguiente estuviera en el contenido CSDL de un archivo .edmx, el contenido de los elementos LongDescription y Summary aparecería en la ventana Propiedades de Visual Studio al hacer clic en el tipo de entidad 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>
Vea también
Conceptos
Información general de Entity Framework
Especificación CSDL
EntityContainer (Elemento) (CSDL)
Otros recursos
Especificaciones CSDL, SSDL y MSL
ADO.NET Entity Data Model Tools
.edmx File Overview