Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Das Documentation-Element in konzeptioneller Schemadefinitionssprache (CSDL) kann verwendet werden, um Informationen zu einem Objekt bereitzustellen, das in einem übergeordneten Element definiert ist.Ist in einer EDMX-Datei das Documentation-Element ein untergeordnetes Element eines anderen Elements, das als Objekt auf der Entwurfsoberfläche des Entity Data Model-Designers (z. B. als Entität, Zuordnung oder Eigenschaft) angezeigt wird, wird der Inhalt des Documentation-Elements im Visual Studio-Fenster Eigenschaften des Objekts angezeigt.
Das Documentation-Element kann die folgenden untergeordneten Elemente aufweisen (der vorliegenden Reihenfolge entsprechend):
Summary: eine kurze Beschreibung des übergeordneten Elements.(kein (Null) oder ein Element)
LongDescription: eine ausführliche Beschreibung des übergeordneten Elements.(kein (Null) oder ein Element)
Anmerkungselemente.(keine (Null) oder mehrere Elemente)
Anwendbare Attribute
Eine beliebige Anzahl von Anmerkungsattributen (benutzerdefinierte XML-Attribute) kann für das Documentation-Element übernommen werden.Benutzerdefinierte Attribute dürfen jedoch zu keinem XML-Namespace gehören, der für CSDL reserviert ist.Die vollqualifizierten Namen für zwei benutzerdefinierte Attribute dürfen nicht übereinstimmen.
Beispiel
Das folgende Beispiel zeigt das Documentation-Element als untergeordnetes Element eines EntityType-Elements.Befände sich der Ausschnitt unten im CSDL-Inhalt einer EDMX-Datei, würde der Inhalt des Summary- und des LongDescription-Elements nach dem Klicken auf den Customer-Entitätstyp im Visual Studio-Fenster Eigenschaften angezeigt.
<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>
Siehe auch
Konzepte
Übersicht über das Entity Framework
EntityContainer-Element (CSDL)