Schemareferenz für Codeausschnitte
Codeausschnitte sind vorautorierte Codeelemente, die bereit sind, in Ihre Anwendung einzufügen. Sie können die Produktivität und Zuverlässigkeit steigern, indem Sie Codeausschnitte verwenden, um den Zeitaufwand für die Eingabe von wiederholten Code oder die Suche nach Beispielen zu reduzieren.
Dieser Artikel enthält einen Verweis auf das XML-Schema von Visual Studio IntelliSense Code Snippet. Sie können das Schema verwenden, um eigene Codeausschnitte zu erstellen und sie den Codeausschnitten hinzuzufügen, die Visual Studio bereits enthält.
- Weitere Informationen zum Erstellen von Codeausschnitten finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Codeausschnitts in Visual Studio.
- Informationen zu den Codeausschnitten, die Visual Studio standardmäßig enthält, finden Sie unter C#-Codeausschnitte oder Visual C++-Codeausschnitte.
Assembly-Element
Gibt den Namen der Assembly an, auf die vom Codeausschnitt verwiesen wird.
Der Textwert des Assembly-Elements entspricht entweder dem benutzerfreundlichen Textnamen der Assembly, beispielsweise System.dll
, oder ihrem starken Namen, beispielsweise System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1
.
<Assembly>
AssemblyName
</Assembly>
Übergeordnetes Element | Beschreibung |
---|---|
Reference-Element | Enthält Informationen über die für den Codeausschnitt erforderlichen Assemblyverweise. |
Ein Textwert ist erforderlich. Dieser Text gibt die Assembly an, auf die der Codeausschnitt verweist.
Author-Element
Gibt den Namen des Autors des Codeausschnitts an. Der Codeausschnitt-Manager zeigt den im Author
-Element des Codeausschnitts gespeicherten Namen an.
<Author>
Code Snippet Author
</Author>
Übergeordnetes Element | Beschreibung |
---|---|
Header-Element | Enthält allgemeine Informationen über den Codeausschnitt. |
Ein Textwert ist erforderlich. Dieser Text gibt den Autor des Codeausschnitts an.
Codeelement
Stellt einen Container für kurze Codeblöcke bereit.
Stichwörter
Zwei reservierte Wörter sind zur Verwendung im Text des Code
-Elements verfügbar: $end$
und $selected$
. $end$
markiert die Position, an die der Cursor zu setzen ist, nachdem der Codeausschnitt eingefügt wurde. $selected$
stellt markierten Dokumenttext dar, der beim Aufrufen des Codeausschnitts in den Codeausschnitt eingefügt werden soll. Betrachten wir beispielsweise einen Ausschnitt, der Folgendes enthält:
$selected$ is a great color.
Wenn das Wort Blue
ausgewählt ist, wenn der Benutzer den Codeausschnitt aufruft, lautet das Ergebnis:
Blue is a great color.
Sie können entweder $end$
oder $selected$
nicht mehr als einmal in einem Codeausschnitt verwenden. Andernfalls wird nur die zweite Instanz erkannt. Betrachten wir einen Ausschnitt, der Folgendes enthält:
$selected$ is a great color. I love $selected$.
Wenn das Wort Blue
ausgewählt ist, lautet das Ergebnis:
is a great color. I love Blue.
Der anfängliche Leerraum wird angezeigt, da es ein Leerzeichen zwischen $selected$
und is
.
Alle anderen $
-Schlüsselwörter werden dynamisch im <Literal>
-Tag und im <Object>
-Tag definiert.
Der folgende Code zeigt die Struktur des Code
Elements:
<Code Language="Language"
Kind="method body/method decl/type decl/page/file/any"
Delimiter="Delimiter">
Code to insert
</Code>
Ein Textwert ist erforderlich. Dieser Text gibt den Code, der verwendet werden kann, wenn dieser Codeausschnitt in eine Codedatei eingefügt wird, zusammen mit den Literalen und Objekten an.
Attribute
Für das Code
Element stehen drei Attribute zur Verfügung:
Sprache. Erforderliches Attribut, das die Sprache des Codeausschnitts angibt. Der Wert muss einer der folgenden Werte sein:
Wert Beschreibung VB
Visual Basic-Codeausschnitt. CSharp
C#-Codeausschnitt. CPP
C++-Codeausschnitt. XAML
XAML-Codeausschnitt. XML
XML-Codeausschnitt. JavaScript
JavaScript-Codeausschnitt. TypeScript
TypeScript-Codeausschnitt. SQL
SQL-Codeausschnitt. HTML
HTML-Codeausschnitt. Kind. Optionales Attribut, das die Art des Codes angibt, den der Codeausschnitt enthält. Der Wert muss einer der folgenden Werte sein:
Wert Beschreibung method body
Der Codeausschnitt ist ein Methodentext und muss daher innerhalb einer Methodendeklaration eingefügt werden. method decl
Der Codeausschnitt ist eine Methode und muss daher innerhalb einer Klasse oder eines Moduls eingefügt werden. type decl
Der Codeausschnitt ist ein Typ und muss daher in eine Klasse, ein Modul oder einen Namespace eingefügt werden. file
Der Codeausschnitt ist eine vollständige Codedatei und kann allein in eine Codedatei oder in einen Namespace eingefügt werden. any
Der Codeausschnitt kann an einer beliebigen Stelle eingefügt werden. Dieses Tag wird für kontextunabhängige Codeausschnitte verwendet, beispielsweise Kommentare. Trennzeichen. Optionales Attribut, das das Trennzeichen angibt, das zum Beschreiben von Literalen und Objekten im Code verwendet wird. Standardmäßig ist
$
das Trennzeichen.
Übergeordnetes Element
Übergeordnetes Element | Beschreibung |
---|---|
Snippet-Element | Enthält die Verweise, Importe, Deklarationen und den Code für den Codeausschnitt. |
CodeSnippet-Element
Ermöglicht die Angabe einer Überschrift und mehrerer Codeschnipsel, die Sie in Visual Studio Codedateien einfügen können.
<CodeSnippet Format="x.x.x">
<Header>... </Header>
<Snippet>... </Snippet>
</CodeSnippet>
attribute | Beschreibung |
---|---|
Format | Erforderliches Attribut. Gibt die Schemaversion des Codeausschnitts an. Das Format-Attribut muss eine Zeichenfolge in der Syntax von x.x.x sein, wobei jedes x einen numerischen Wert der Versionsnummer darstellt. Visual Studio ignoriert Codeausschnitte mit Formatattributen , die nicht verstanden werden. |
Untergeordnetes Element | Beschreibung |
---|---|
Header-Element | Erforderliches Element. Enthält allgemeine Informationen über den Codeausschnitt. Es muss genau ein Header -Element in einem Codeausschnitt vorhanden sein. |
Snippet-Element | Erforderliches Element. Enthält den Code, der von Visual Studio eingefügt werden soll. Es muss genau ein Snippet -Element in einem Codeausschnitt vorhanden sein. |
Übergeordnetes Element | Beschreibung |
---|---|
CodeSnippets-Element | Stammelement des XML-Schemas für den Codeausschnitt. |
CodeSnippets-Element
Gruppiert CodeSnippet-Elemente. Das CodeSnippets
-Element ist das Stammelement des XML-Schemas des Codeausschnitts.
<CodeSnippets>
<CodeSnippet>... </CodeSnippet>
</CodeSnippets>
Untergeordnetes Element | Beschreibung |
---|---|
CodeSnippet-Element | Optionales Element. Übergeordnetes Element für alle Codeausschnittdaten. Es kann keine oder mehrere CodeSnippet -Elemente in einem CodeSnippets -Element geben. |
Declarations-Element
Gibt die Literale und Objekte an, die die bearbeitbaren Teile eines Codeausschnitts darstellen.
<Declarations>
<Literal>... </Literal>
<Object>... </Object>
</Declarations>
Untergeordnetes Element | Beschreibung |
---|---|
Literal-Element | Optionales Element. Definiert die bearbeitbaren Literale des Codeausschnitts an. Es kann keine oder mehrere Literal -Elemente in einem Declarations -Element geben. |
Object-Element | Optionales Element. Definiert die Objekte des Codeausschnitts an, die bearbeitet werden können. Es kann keine oder mehrere Object -Elemente in einem Declarations -Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
Snippet-Element | Enthält die Verweise, Importe, Deklarationen und den Code für den Codeausschnitt. |
Default-Element
Gibt den Standardwert des Literals oder Objekts für einen Codeausschnitt an.
<Default>
Default value
</Default>
Übergeordnetes Element | Beschreibung |
---|---|
Literal-Element | Definiert die Literalfelder des Codeausschnitts, die Sie bearbeiten können. |
Object-Element | Definiert die Objektfelder des Codeausschnitts, die Sie bearbeiten können. |
Ein Textwert ist erforderlich. Dieser Text gibt den Standardwert des Literals oder Objekts an, das die Felder des bearbeitbaren Codeausschnitts füllt.
Description-Element
Gibt beschreibende Informationen zum Inhalt eines Codeausschnitts an.
<Description>
Code Snippet Description
</Description>
Übergeordnetes Element | Beschreibung |
---|---|
Header-Element | Enthält allgemeine Informationen über den Codeausschnitt. |
Ein Textwert ist erforderlich. Dieser Text beschreibt den Codeausschnitt.
Function-Element
Gibt eine Funktion an, die ausgeführt wird, wenn das Literal oder Objekt in Visual Studio den Fokus erhält.
Hinweis
Nicht alle Sprachen unterstützen Function
-Elemente. Informationen zu den verfügbaren Funktionen finden Sie in den jeweiligen sprachspezifischen Dokumentationen.
<Function>
FunctionName
</Function>
Übergeordnetes Element | Beschreibung |
---|---|
Literal-Element | Definiert die Literalfelder des Codeausschnitts, die Sie bearbeiten können. |
Object-Element | Definiert die Objektfelder des Codeausschnitts, die Sie bearbeiten können. |
Ein Textwert ist erforderlich. Dieser Text bezeichnet eine Funktion, die ausgeführt wird, wenn das Literal- oder Objektfeld in Visual Studio den Fokus erhält.
Header-Element
Bezeichnet allgemeine Informationen über den Codeausschnitt.
<Header>
<Title>... </Title>
<Author>... </Author>
<Description>... </Description>
<HelpUrl>... </HelpUrl>
<SnippetTypes>... </SnippetTypes>
<Keywords>... </Keywords>
<Shortcut>... </Shortcut>
</Header>
Untergeordnetes Element | Beschreibung |
---|---|
Author-Element | Optionales Element. Der Name der Person oder der Firma, die den Codeausschnitt erstellt hat. Es kann null oder ein Author Element in einem Header Element geben. |
Description-Element | Optionales Element. Eine Beschreibung des Codeausschnitts. Es kann null oder ein Description Element in einem Header Element geben. |
HelpUrl-Element | Optionales Element. Eine URL, die weitere Informationen über den Codeausschnitt enthält. Es kann null oder ein HelpURL Element in einem Header Element geben. |
Keywords-Element | Optionales Element. Gruppiert Keyword -Elemente. Es kann null oder ein Keywords Element in einem Header Element geben. |
Shortcut-Element | Optionales Element. Gibt den Verknüpfungstext an, der zum Einfügen des Ausschnitts verwendet werden kann. Es kann null oder ein Shortcut Element in einem Header Element geben. |
SnippetTypes-Element | Optionales Element. Gruppiert SnippetType -Elemente. Es kann null oder ein SnippetTypes Element in einem Header Element geben. Wenn keine SnippetTypes -Elemente verfügbar sind, ist der Codeausschnitt immer gültig. |
Title-Element | Erforderliches Element. Der benutzerfreundliche Name des Codeausschnitts. Es muss genau ein Title -Element in einem Header -Element vorhanden sein. |
Übergeordnetes Element | Beschreibung |
---|---|
CodeSnippet-Element | Übergeordnetes Element für alle Codeausschnittdaten. |
HelpUrl-Element
Gibt eine URL zu weiteren Informationen über einen Codeausschnitt an.
Hinweis
Visual Studio verwendet das HelpUrl
Element nicht. Das Element ist Teil des IntelliSense Code Snippet XML-Schemas und Codeausschnitte, die das Element überprüfen, aber der Wert des Elements wird nie verwendet.
<HelpUrl>
www.microsoft.com
</HelpUrl>
Übergeordnetes Element | Beschreibung |
---|---|
Header-Element | Enthält allgemeine Informationen über den Codeausschnitt. |
Ein Textwert ist optional. Dieser Text bezeichnet die aufzurufende URL, die weitere Informationen über einen Codeausschnitt enthält.
ID-Element
Gibt einen eindeutigen Bezeichner für ein Literal
-Element oder ein Object
-Element an. Zwei Literale oder Objekte im selben Codeausschnitt können nicht über den gleichen Textwert im ID
-Element verfügen. Literale und Objekte können kein Element mit ID
einem Wert von end
enthalten. Der Wert $end$
ist reserviert. Mit diesem Wert wird die Stelle gekennzeichnet, an der der Cursor nach dem Einfügen des Codeausschnitts positioniert wird.
<ID>
Unique Identifier
</ID>
Übergeordnetes Element | Beschreibung |
---|---|
Literal-Element | Definiert die Literalfelder des Codeausschnitts, die Sie bearbeiten können. |
Object-Element | Definiert die Objektfelder des Codeausschnitts, die Sie bearbeiten können. |
Ein Textwert ist erforderlich. Dieser Text bezeichnet den eindeutigen Bezeichner für das Objekt oder Literal.
Import-Element
Gibt die importierten Namespaces an, die von einem Codeausschnitt verwendet werden.
<Import>
<Namespace>... </Namespace>
</Import>
Untergeordnetes Element | Beschreibung |
---|---|
Namespace-Element | Erforderliches Element. Gibt den vom Codeausschnitt verwendeten Namespace an. Es muss genau ein Namespace -Element in einem Import -Element vorhanden sein. |
Übergeordnetes Element | Beschreibung |
---|---|
Imports-Element | Gruppierungselement für Import -Elemente. |
Imports-Element
Gruppiert einzelne Import
-Elemente.
<Imports>
<Import>... </Import>
</Imports>
Untergeordnetes Element | Beschreibung |
---|---|
Import-Element | Optionales Element. Enthält die importierten Namespaces für den Codeausschnitt. Es kann keine oder mehrere Import -Elemente in einem Imports -Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
Snippet-Element | Enthält die Verweise, Importe, Deklarationen und den Code für den Codeausschnitt. |
Keyword-Element
Gibt ein benutzerdefiniertes Schlüsselwort für den Codeausschnitt an. Die Schlüsselwörter des Codeausschnitts werden von Visual Studio verwendet und bieten Onlineinhaltsanbietern eine Standardmöglichkeit zum Hinzufügen von benutzerdefinierten Schlüsselwörtern für Suche und Kategorisierung.
<Keyword>
Code Snippet Keyword
</Keyword>
Übergeordnetes Element | Beschreibung |
---|---|
Keywords-Element | Gruppiert einzelne Keyword -Elemente. |
Ein Textwert ist erforderlich. Das Schlüsselwort für den Codeausschnitt.
Keywords-Element
Gruppiert einzelne Keyword
-Elemente. Die Schlüsselwörter des Codeausschnitts werden von Visual Studio verwendet und bieten Onlineinhaltsanbietern eine Standardmöglichkeit zum Hinzufügen von benutzerdefinierten Schlüsselwörtern für Suche und Kategorisierung.
<Keywords>
<Keyword>... </Keyword>
<Keyword>... </Keyword>
</Keywords>
Untergeordnetes Element | Beschreibung |
---|---|
Keyword-Element | Optionales Element. Enthält einzelne Schlüsselwörter für den Codeausschnitt. Es kann keine oder mehrere Keyword -Elemente in einem Keywords -Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
Header-Element | Enthält allgemeine Informationen über den Codeausschnitt. |
Literalelement
Definiert die bearbeitbaren Literale des Codeausschnitts an. Das Literal
Element identifiziert einen Ersatz für einen Codeabschnitt, der vollständig im Codeausschnitt enthalten ist, der nach dem Einfügen des Codeausschnitts angepasst werden kann. So sollten beispielsweise Literalzeichenfolgen, numerische Werte und einige Variablennamen als Literale deklariert werden.
Literale und Objekte können kein Element mit ID
einem Wert von selected
oder .end
Der Wert $selected$
stellt den markierten Dokumenttext dar, der beim Aufrufen des Codeausschnitts in den Codeausschnitt eingefügt werden soll. $end$
markiert die Position, an die der Cursor zu setzen ist, nachdem der Codeausschnitt eingefügt wurde.
<Literal Editable="true/false">
<ID>... </ID>
<ToolTip>... </ToolTip>
<Default>... </Default>
<Function>... </Function>
</Literal>
Attribut | Beschreibung |
---|---|
Bearbeitbaren | Optionales Boolean -Attribut. Gibt an, ob das Literal bearbeitet werden kann, nachdem der Codeausschnitt eingefügt wurde. Der Standardwert dieses Attributs ist true . |
Untergeordnetes Element | Beschreibung |
---|---|
Default-Element | Erforderliches Element. Gibt den Standardwert des Literals an, wenn Sie den Codeausschnitt einfügen. Es muss genau ein Default -Element in einem Literal -Element vorhanden sein. |
Function-Element | Optionales Element. Gibt eine Funktion an, die ausgeführt werden soll, wenn das Literal in Visual Studio den Fokus erhält. Es kann null oder ein Function Element in einem Literal Element geben. |
ID-Element | Erforderliches Element. Gibt einen eindeutigen Bezeichner für das Literal an. Es muss genau ein ID -Element in einem Literal -Element vorhanden sein. |
ToolTip-Element | Optionales Element. Beschreibt den erwarteten Wert sowie die Verwendungsweise des Literals. Es kann null oder ein ToolTip Element in einem Literal Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
Declarations-Element | Enthält die Literale und Objekte eines Codeausschnitts, die Sie bearbeiten können. |
Namespace-Element
Gibt den Namespace an, der für die Kompilierung und Ausführung des Codeausschnitts importiert werden muss. Der im Namespace
-Element angegebene Namespace wird automatisch einer using
- oder Imports
-Anweisung am Anfang des Codes hinzugefügt, sofern er nicht bereits vorhanden ist.
<Namespace>
Namespace
</Namespace>
Übergeordnetes Element | Beschreibung |
---|---|
Import-Element | Importiert den angegebenen Namespace. |
Ein Textwert ist erforderlich. Dieser Text gibt einen importierten Namespace an, der Voraussetzung für den Codeausschnitt ist.
Object-Element
Definiert die Objekte des Codeausschnitts an, die bearbeitet werden können. Das Object
Element identifiziert ein Element, das vom Codeausschnitt benötigt wird, der außerhalb des Codeausschnitts selbst definiert ist. Beispielsweise sollten Windows Forms-Steuerelemente, ASP.NET-Steuerelemente, Objektinstanzen und Typinstanzen als Objekte deklariert werden. Für Objektdeklarationen muss ein Typ angegeben werden, der mit dem Type
Element erfolgt.
<Object Editable="true/false">
<ID>... </ID>
<Type>... </Type>
<ToolTip>... </ToolTip>
<Default>... </Default>
<Function>... </Function>
</Object>
Attribute | Beschreibung |
---|---|
Bearbeitbaren | Optionales Boolean -Attribut. Gibt an, ob das Literal bearbeitet werden kann, nachdem der Codeausschnitt eingefügt wurde. Der Standardwert dieses Attributs ist true . |
Untergeordnetes Element | Beschreibung |
---|---|
Default-Element | Erforderliches Element. Gibt den Standardwert des Literals an, wenn Sie den Codeausschnitt einfügen. Es muss genau ein Default -Element in einem Literal -Element vorhanden sein. |
Function-Element | Optionales Element. Gibt eine Funktion an, die ausgeführt werden soll, wenn das Literal in Visual Studio den Fokus erhält. Es kann null oder ein Function Element in einem Literal Element geben. |
ID-Element | Erforderliches Element. Gibt einen eindeutigen Bezeichner für das Literal an. Es muss genau ein ID -Element in einem Literal -Element vorhanden sein. |
ToolTip-Element | Optionales Element. Beschreibt den erwarteten Wert sowie die Verwendungsweise des Literals. Es kann null oder ein ToolTip Element in einem Literal Element geben. |
Type-Element | Erforderliches Element. Gibt den Typ des Objekts an. Es muss genau ein Type -Element in einem Object -Element vorhanden sein. |
Übergeordnetes Element | Beschreibung |
---|---|
Declarations-Element | Enthält die Literale und Objekte eines Codeausschnitts, die Sie bearbeiten können. |
Reference-Element
Bezeichnet Informationen über die für den Codeausschnitt erforderlichen Assemblyverweise.
<Reference>
<Assembly>... </Assembly>
<Url>... </Url>
</Reference>
Untergeordnetes Element | Beschreibung |
---|---|
Assembly-Element | Erforderliches Element. Enthält den Namen der Assembly, auf die vom Codeausschnitt verwiesen wird. Es muss genau ein Assembly -Element in einem Reference -Element vorhanden sein. |
URL-Element | Optionales Element. Enthält eine URL, die weitere Informationen über die Assembly bereitstellt, auf die verwiesen wird. Es kann null oder ein Url Element in einem Reference Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
References-Element | Gruppierungselement für Reference -Elemente. |
References-Element
Gruppiert einzelne Reference
-Elemente.
<References>
<Reference>... </Reference>
</References>
Untergeordnetes Element | Beschreibung |
---|---|
Reference-Element | Optionales Element. Enthält Informationen zu Assemblyverweisen für den Codeausschnitt. Es kann keine oder mehrere Reference -Elemente in einem References -Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
Snippet-Element | Enthält die Verweise, Importe, Deklarationen und den Code für den Codeausschnitt. |
Shortcut-Element
Gibt den Verknüpfungstext an, der zum Einfügen des Codeausschnitts verwendet wird. Der Textwert eines Shortcut
Elements darf nur alphanumerische Zeichen und Unterstriche (_
) enthalten.
Hinweis
Das Unterstrichzeichen (_
) wird in C++-Codeausschnittverknüpfungen nicht unterstützt.
<Shortcut>
Shortcut Text
</Shortcut>
Übergeordnetes Element | Beschreibung |
---|---|
Header-Element | Enthält allgemeine Informationen über den Codeausschnitt. |
Ein Textwert ist optional. Dieser Text wird als Verknüpfung zum Einfügen des Codeausschnitts verwendet.
Snippet-Element
Gibt die Verweise, Importe, Deklarationen und den Code für den Codeausschnitt an.
<Snippet>
<References>... </References>
<Imports>... </Imports>
<Declarations>... </Declarations>
<Code>... </Code>
</Snippet>
Untergeordnetes Element | Beschreibung |
---|---|
Code-Element | Erforderliches Element. Gibt den Code an, den Sie in eine Dokumentationsdatei einfügen möchten. Es muss genau ein Code -Element in einem Snippet -Element vorhanden sein. |
Declarations-Element | Optionales Element. Gibt die Literale und Objekte an, die die bearbeitbaren Teile eines Codeausschnitts darstellen. Es kann null oder ein Declarations Element in einem Snippet Element geben. |
Imports-Element | Optionales Element. Gruppiert einzelne Import -Elemente. Es kann null oder ein Imports Element in einem Snippet Element geben. |
References-Element | Optionales Element. Gruppiert einzelne Reference -Elemente. Es kann null oder ein References Element in einem Snippet Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
CodeSnippet-Element | Ermöglicht die Angabe einer Überschrift und mehrerer Codeschnipsel, die Sie in Visual Studio Codedateien einfügen können. |
SnippetType-Element
Gibt an, wie Visual Studio den Codeausschnitt hinzufügt.
<SnippetType>
SurroundsWith/Expansion
</SnippetType>
Übergeordnetes Element | Beschreibung |
---|---|
SnippetTypes-Element | Gruppiert SnippetType -Elemente. |
Der Wert muss einer der folgenden Werte sein:
Wert | Beschreibung |
---|---|
Expansion |
Ermöglicht das Einfügen des Codeausschnitts an den Cursor. |
Refactoring |
Gibt an, dass der Codeausschnitt während der C#-Umgestaltung verwendet wird. Refactoring kann nicht in benutzerdefinierten Codeausschnitten verwendet werden. |
SurroundsWith |
Ermöglicht das Platzieren des Codeausschnitts um einen ausgewählten Codeabschnitt. |
SnippetTypes-Element
Gruppiert einzelne SnippetType
-Elemente. Wenn das Element nicht vorhanden ist, kann der SnippetTypes
Codeausschnitt am Cursor eingefügt oder um den markierten Code platziert werden.
<SnippetTypes>
<SnippetType>... </SnippetType>
<SnippetType>... </SnippetType>
</SnippetTypes>
Untergeordnetes Element | Beschreibung |
---|---|
SnippetType-Element | Optionales Element. Gibt an, wie Visual Studio den Codeausschnitt im Code einfügt. Es kann keine oder mehrere SnippetType -Elemente in einem SnippetTypes -Element geben. |
Übergeordnetes Element | Beschreibung |
---|---|
Header-Element | Bezeichnet allgemeine Informationen über den Codeausschnitt. |
Title-Element
Gibt den Titel für den Codeausschnitt an. Der im Title
Element des Codeausschnitts gespeicherte Titel wird in der Codeausschnittauswahl und als Name des Codeausschnitts im Codeausschnitt-Manager angezeigt.
<Title>
Code Snippet Title
</Title>
Übergeordnetes Element | Beschreibung |
---|---|
Header-Element | Bezeichnet allgemeine Informationen über den Codeausschnitt. |
Ein Textwert ist erforderlich. Dieser Text gibt den Titel des Codeausschnitts an.
ToolTip-Element
Beschreibt den erwarteten Wert und die Verwendung eines Literals oder Objekts in einem Codeausschnitt. Visual Studio zeigt diese Informationen in einer QuickInfo an, wenn der Codeausschnitt in ein Projekt eingefügt wird. Die QuickInfo wird auch angezeigt, wenn die Maus auf das Literal oder Objekt zeigt, nachdem der Codeausschnitt eingefügt wurde.
<ToolTip>
ToolTip description
</ToolTip>
Übergeordnetes Element | Beschreibung |
---|---|
Literal-Element | Definiert die Literalfelder des Codeausschnitts, die Sie bearbeiten können. |
Object-Element | Definiert die Objektfelder des Codeausschnitts, die Sie bearbeiten können. |
Ein Textwert ist erforderlich. Dieser Text gibt die QuickInfo-Beschreibung an, die dem Objekt oder Literal im Codeausschnitt zugeordnet werden soll.
Type-Element
Gibt den Typ des Objekts an. Das Object
Element identifiziert ein Element, das der Codeausschnitt benötigt, aber wahrscheinlich außerhalb des Codeausschnitts selbst definiert ist. Beispielsweise sollten Windows Forms-Steuerelemente, ASP.NET-Steuerelemente, Objektinstanzen und Typinstanzen als Objekte deklariert werden. Für Objektdeklarationen muss ein Typ angegeben werden, der mit dem Type
Element erfolgt.
<Type>
Type
</Type>
Übergeordnetes Element | Beschreibung |
---|---|
Object-Element | Definiert die Objektfelder des Codeausschnitts, die Sie bearbeiten können. |
Ein Textwert ist erforderlich. Dieser Text gibt den Typ des Objekts an. Zum Beispiel:
<Type>System.Data.SqlClient.SqlConnection</Type>
URL-Element
Gibt eine URL an, die weitere Informationen über die referenzierte Assembly bietet.
Hinweis
Das Url
Element wird nur für Visual Basic-Projekte unterstützt.
<Url>
www.microsoft.com
</Url>
Übergeordnetes Element | Beschreibung |
---|---|
Reference-Element | Gibt die vom Codeausschnitt benötigten Assemblyverweise an. |
Ein Textwert ist erforderlich. Dieser Text bezeichnet eine URL mit weiteren Informationen über die Assembly, auf die verwiesen wird. Diese URL wird angezeigt, wenn der Verweis dem Projekt nicht hinzugefügt werden kann.