Elemento Documentation (CSDL)

L'elemento Documentation in Conceptual Schema Definition Language (CSDL) può essere utilizzato per fornire informazioni su un oggetto che è definito in un elemento padre. In un file .edmx, quando l'elemento Documentation è un figlio di un elemento che appare come un oggetto nell'area di progettazione di Entity Data Model Designer (ad esempio un'entità, un'associazione o una proprietà), il contenuto dell'elemento Documentation apparirà nella finestra delle proprietà di Visual Studio per l'oggetto.

L'elemento Documentation può includere i seguenti elementi figlio (nell'ordine elencato):

• Summary: breve descrizione dell'elemento padre. Zero o un elemento.

• LongDescription: descrizione luna dell'elemento padre. Zero o un elemento.

• Elementi Annotation. Zero o più elementi.

Attributi applicabili

È possibile applicare un qualsiasi numero di attributi di annotazione (attributi XML personalizzati) all'elemento Documentation. Tuttavia, gli attributi personalizzati non possono appartenere ad alcuno spazio dei nomi XML riservato a CSDL. I nomi completi per due attributi personalizzati qualsiasi non possono essere uguali.

Esempio

Nell'esempio seguente viene mostrato l'elemento Documentation come un elemento figlio di un elemento EntityType. Se il frammento riportato di seguito fosse nel contenuto CSDL di un file .edmx, il contenuto degli elementi Summary e LongDescription sarebbe visualizzato nella finestra delle proprietà di Visual Studio quando si fa clic sul tipo di 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>

Vedere anche

Concetti

Panoramica su Entity Framework
Specifiche CSDL
Elemento EntityContainer (CSDL)

Altre risorse

Specifiche CSDL, SSDL e MSL
ADO.NET Entity Data Model Tools
.edmx File Overview