Élément Documentation (CSDL)

  • Article

L'élément Documentation dans le langage CSDL (Conceptual Schema Definition Language) permet de fournir des informations sur un objet défini dans un élément parent. Dans un fichier .edmx, lorsque l'élément Documentation est un enfant d'un élément qui apparaît comme un objet sur l'aire de conception d'Entity Data Model Designer (tel qu'une entité, une association ou une propriété), le contenu de l'élément Documentation apparaîtra dans la fenêtre Propriétés Visual Studio pour l'objet.

L'élément Documentation peut avoir les éléments enfants suivants (dans l'ordre répertorié) :

  • Summary : brève description de l'élément parent (zéro ou un élément) ;

  • LongDescription : description détaillée de l'élément parent (zéro ou un élément) ;

  • éléments d'annotation (zéro, un ou plusieurs éléments).

Attributs applicables

Un nombre quelconque d'attributs d'annotation (attributs XML personnalisés) peut être appliqué à l'élément Documentation. Toutefois, les attributs personnalisés ne peuvent pas appartenir à un espace de noms XML réservé pour le langage CSDL. Les noms qualifiés complets de deux attributs personnalisés quelconques ne peuvent pas être identiques.

Exemple

L'exemple ci-dessous illustre l'élément Documentation comme élément enfant d'un élément EntityType. Si l'extrait de code ci-dessous figure dans le contenu CSDL d'un fichier .edmx, le contenu des éléments Summary et LongDescription s'affiche dans la fenêtre Propriétés Visual Studio lorsque vous cliquez sur le type d'entité 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>

Voir aussi

Concepts

Vue d'ensemble d'Entity Framework
Spécification CSDL
Élément EntityContainer (CSDL)

Autres ressources

Spécifications CSDL, SSDL et MSL
ADO.NET Entity Data Model Tools
.edmx File Overview