Partager via

Élément Documentation (SSDL)

  • Article

Dans le langage SSDL (Store Schema Definition Language), l'élément Documentation permet de fournir des informations sur un objet défini dans un élément parent.

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

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 présente l'élément Documentation en tant qu'élément enfant d'un élément 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>

Voir aussi

Concepts

Vue d'ensemble d'Entity Framework
Spécification SSDL

Autres ressources

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