Freigeben über

Schemareferenz für Codeausschnitte

  • Artikel

IntelliSense-Codeausschnitte sind vorab erstellte Codeelemente, die mithilfe von Visual Studio direkt in eine Anwendung eingefügt werden können. Solche Codeausschnitte erhöhen die Produktivität, da sie Zeit bei der Eingabe von wiederholtem Code oder bei der Suche nach Beispielen einsparen. Mithilfe des XML-Schemas für IntelliSense-Codeausschnitte können Sie eigene Codeausschnitte oder XML-Codeausschnitte erstellen und den bereits in Visual Studio enthaltenen Codeausschnitten hinzufügen.

Schemaelemente für IntelliSense-Codeausschnitte

Assembly Element

HelpUrl Element

References Element

Author Element

ID Element

Shortcut Element

Code Element

Import Element

Snippet Element

CodeSnippet Element

Imports Element

SnippetType Element

CodeSnippets Element

Keyword Element

SnippetTypes Element

Declarations Element

Keywords Element

Title Element

Default Element

Literal Element

ToolTip Element

Description Element

Namespace Element

Type Element

Function Element

Object Element

Url Element

Header Element

Reference Element

Assembly-Element

Gibt den Namen der Assembly an, auf die vom Codeausschnitt verwiesen wird.

Hinweis

Das Assembly-Element wird nur in Visual Basic-Codeausschnitten unterstützt.

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>

Parent-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>

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

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 Text dar, der im Dokument ausgewählt wurde, das in den Ausschnitt eingefügt werden soll, wenn dieser aufgerufen wird. Betrachten wir beispielsweise einen Ausschnitt, der Folgendes enthält:

$selected$ is a great color.

Wenn das Wort "Blue" aktiviert ist, wenn der Benutzer die Vorlage aufruft, ist 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" aktiviert ist, ist das Ergebnis:

 is a great color. I love Blue.

Der ursprüngliche Speicherplatz wird angezeigt, weil ein zwischen Leerzeichen $selected$ und isvorhanden ist.

Alle anderen $-Schlüsselwörter werden dynamisch im <Literal>-Tag und im <Object>-Tag definiert.

<Code Language="Language"
    Kind="method body/method decl/type decl/page/file/any"
    Delimiter="Delimiter">
    Code to insert
</Code>

Attribut

Beschreibung

Delimiter

Optionales Attribut. Gibt das Trennzeichen an, das zum Beschreiben von Literalen und Objekten im Code verwendet wird. Standardmäßig ist $ das Trennzeichen.

Kind

Optionales Attribut. Gibt die Art des Codes an, den der Ausschnitt enthält, sowie die Position, an der ein Codeausschnitt eingefügt werden muss, damit der Code kompiliert wird. Die verfügbaren Werte lauten method body, method decl, type decl, file und any.

Language

Erforderliches Attribut. Gibt die Programmiersprache des Codeausschnitts an.

Kind-Attributwert

Beschreibung

method body

Gibt an, dass der Codeausschnitt einen Methodenrumpf darstellt und daher innerhalb einer Methodendeklaration eingefügt werden muss.

method decl

Gibt an, dass der Codeausschnitt eine Methode ist und daher innerhalb eine Klasse oder eines Moduls eingefügt werden muss.

type decl

Gibt an, dass der Codeausschnitt ein Typ ist und daher innerhalb eine Klasse, eines Modul oder eines Namespace eingefügt werden muss.

file

Gibt an, dass der Ausschnitt eine vollständige Codedatei ist. Diese Codeausschnitte können eigenständig in eine Codedatei oder einen Namespace eingefügt werden.

any

Gibt an, dass der Ausschnitt überall eingefügt werden kann. Dieses Tag wird für kontextunabhängige Codeausschnitte verwendet, beispielsweise Kommentare.

Language-Attributwert

Beschreibung

VB

Bezeichnet einen Visual Basic-Codeausschnitt.

CSharp

Bezeichnet einen C#-Codeausschnitt.

CPP

Bezeichnet einen C++-Codeausschnitt.

XML

Bezeichnet einen XML-Codeausschnitt.

JavaScript

Bezeichnet einen JavaScript-Codeausschnitt.

SQL

Bezeichnet einen SQL-Codeausschnitt.

HTML

Bezeichnet einen HTML-Codeausschnitt.

Parent-Element

Beschreibung

Snippet Element

Enthält die Verweise, Importe, Deklarationen und den Code für den Codeausschnitt.

Ein Textwert ist erforderlich. Dieser Text bezeichnet den Code zusammen mit den Literalen und Objekten an, die verwendet werden können, wenn dieser Codeausschnitt in ein Projekt eingefügt wird.

CodeSnippet-Element

Ermöglicht die Angabe einer Überschrift und mehrerer IntelliSense-Codeausschnitte, die Sie in Visual Studio-Codedateien einfügen können.

<CodeSnippet Format="x.x.x">
    <Header>... </Header>
    <Snippet>... </Snippet>
</CodeSnippet>

Attribut

Beschreibung

Format

Erforderliches Attribut. Gibt die Schemaversion des Codeausschnitts an. Das Formatattribut muss eine Zeichenfolge mit der Syntax "x.x.x" sein, wobei jedes "x" einen numerischen Wert der Versionsnummer darstellt. Visual Studio ignoriert Codeausschnitte mit Format-Attributen, 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 wird. Es muss genau ein Snippet-Element in einem Codeausschnitt vorhanden sein.

Parent-Element

Beschreibung

CodeSnippets Element

Stammelement des XML-Schemas für den Codeausschnitt.

CodeSnippets-Element

Gruppiert CodeSnippet Element-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.

Parent-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 IntelliSense-Codeausschnitt an.

<Default>
    Default value
</Default>

Parent-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

Bezeichnet beschreibende Informationen über den Inhalt eines IntelliSense-Codeausschnitts.

<Description>
    Code Snippet Description
</Description>

Parent-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

Das Function-Element wird nur in Visual C#-Codeausschnitten unterstützt.

<Function>
    FunctionName
</Function>

Parent-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

Gibt allgemeine Informationen über den IntelliSense-Codeausschnitt an.

<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. Ein Header-Element kann kein oder ein Author-Element enthalten.

Description Element

Optionales Element. Eine Beschreibung des Codeausschnitts. Ein Header-Element kann kein oder ein Description-Element enthalten.

HelpUrl Element

Optionales Element. Eine URL, die weitere Informationen über den Codeausschnitt enthält. Ein Header-Element kann kein oder ein HelpURL-Element enthalten.

Hinweis

Visual Studio verwendet das HelpUrl-Element nicht.Das Element ist Bestandteil des XML-Schemas für IntelliSense-Codeausschnitte. Alle Codeausschnitte mit dem Element werden überprüft, der Wert des Elements wird jedoch nie verwendet.

Keywords Element

Optionales Element. Gruppiert Keyword-Elemente. Ein Header-Element kann kein oder ein Keywords-Element enthalten.

Shortcut Element

Optionales Element. Gibt den Verknüpfungstext an, der zum Einfügen des Ausschnitts verwendet werden kann. Ein Header-Element kann kein oder ein Shortcut-Element enthalten.

SnippetTypes Element

Optionales Element. Gruppiert SnippetType-Elemente. Ein Header-Element kann kein oder ein SnippetTypes-Element enthalten. 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.

Parent-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 Bestandteil des XML-Schemas für IntelliSense-Codeausschnitte. Alle Codeausschnitte mit dem Element werden überprüft, der Wert des Elements wird jedoch nie verwendet.

<HelpUrl>
    www.microsoft.com
</HelpUrl>

Parent-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. Die Textwert in den ID-Elementen zweier Literale oder Objekte im selben Codeausschnitt dürfen nicht übereinstimmen. Literale und Objekte dürfen kein ID-Element mit dem Wert "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>

Parent-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 IntelliSense-Codeausschnitt verwendet werden.

Hinweis

Das Import-Element wird nur für Visual Basic-Projekte unterstützt.

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

Parent-Element

Beschreibung

Imports Element

Gruppierungselements für Import-Elemente.

Imports-Element

Gruppiert einzelne Import-Elemente.

Hinweis

Das Imports-Element wird nur für Visual Basic-Projekte unterstützt.

<Imports>
    <Import>... </Import>
<Imports>

Untergeordnetes Element

Beschreibung

Import Element

Optionales Element. Enthält die importierten Namespaces für den Codeausschnitt. Ein Imports-Element kann keine oder mehrere Import-Elemente enthalten.

Parent-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>

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

Parent-Element

Beschreibung

Header Element

Enthält allgemeine Informationen über den Codeausschnitt.

Literalelement

Definiert die bearbeitbaren Literale des Codeausschnitts an. Das Literal-Element wird verwendet, um eine Ersetzung für ein Codeelement zu kennzeichnen, das zwar vollständig im Ausschnitt enthalten ist, nach dem Einfügen in den Code jedoch wahrscheinlich geändert wird. So sollten beispielsweise Literalzeichenfolgen, numerische Werte und einige Variablennamen als Literale deklariert werden.

Literale und Objekte können kein ID-Element mit dem Wert "selected" oder "end" enthalten. Der Wert $selected$ stellt den im Dokument ausgewählten Text dar, der beim Aufruf in den Ausschnitt 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

Editable

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. Ein Literal-Element kann kein oder ein Function-Element enthalten.

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 kein oder ein Tooltip-Element in einem Literal enthalten sein.

Parent-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 Imports-Anweisung am Anfang des Codes hinzugefügt, sofern er nicht bereits vorhanden ist.

Hinweis

Das Namespace-Element wird nur für Visual Basic-Projekte unterstützt.

<Namespace>
    Namespace
</Namespace>

Parent-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 wird zur Kennzeichnung eines vom Codeausschnitt benötigten Elements verwendet, das möglicherweise jedoch außerhalb des Codeausschnitts selbst definiert wird. Beispielsweise sollten Windows Forms-Steuerelemente, ASP.NET-Steuerelemente, Objektinstanzen und Typinstanzen als Objekte deklariert werden. Für Objektdeklarationen muss ein Typ angegeben werden. Zu diesem Zweck wird das Type-Element verwendet.

<Object Editable="true/false">
    <ID>... </ID>
    <Type>... </Type>
    <ToolTip>... </ToolTip>
    <Default>... </Default>
    <Function>... </Function>
</Object>

Attribut

Beschreibung

Editable

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. Ein Literal-Element kann kein oder ein Function-Element enthalten.

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 kein oder ein Tooltip-Element in einem Literal enthalten sein.

Type Element

Erforderliches Element. Gibt den Typ des Objekts an. Es muss genau ein Type-Element in einem Object-Element vorhanden sein.

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

Hinweis

Das Reference-Element wird nur für Visual Basic-Projekte unterstützt.

<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. Ein Reference-Element kann kein oder ein Url-Element enthalten.

Parent-Element

Beschreibung

References Element

Gruppierungselement für Reference-Elemente.

References-Element

Gruppiert einzelne Reference-Elemente.

Hinweis

Das References-Element wird nur für Visual Basic-Projekte unterstützt.

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

Parent-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 kann nur alphanumerische Zeichen, Bindestriche ( - ) und Unterstriche ( _ ) enthalten.

Warnung

Die Zeichen "_" und "–“ werden in C++-Ausschnittsverknüpfungen nicht unterstützt.

<Shortcut>
    Shortcut Text
</Shortcut>

Parent-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. Ein Snippet-Element kann kein oder ein Declarations-Element enthalten.

Imports Element

Optionales Element. Gruppiert einzelne Import-Elemente. Ein Snippet-Element kann kein oder ein Imports-Element enthalten.

Optionales Element. Gruppiert einzelne Reference-Elemente. Ein Snippet-Element kann kein oder ein References-Element enthalten.

Parent-Element

Beschreibung

CodeSnippet Element

Ermöglicht die Angabe einer Überschrift und mehrerer IntelliSense-Codeausschnitte, die Sie in Visual Studio-Codedateien einfügen können.

SnippetType-Element

Gibt an, wie Visual Studio den Codeausschnitt einfügt.

<SnippetType>
    SurroundsWith/Expansion
<SnippetType>

Parent-Element

Beschreibung

SnippetTypes Element

Gruppiert SnippetType-Elemente.

Der Textwert muss einer der folgenden Werte sein:

  • SurroundsWith: Der Codeausschnitt kann ein ausgewähltes Codeelement umschließen.

  • Expansion: Der Codeausschnitt kann an der Cursorposition eingefügt werden.

  • Refactoring: Der Codeausschnitt wird während der Visual C#-Umgestaltung verwendet. Refactoring kann in benutzerdefinierten Codeausschnitten nicht verwendet werden.

SnippetTypes-Element

Gruppiert einzelne SnippetType-Elemente. Wenn das SnippetTypes-Element nicht vorhanden ist, kann der Codeausschnitt an beliebiger Stelle im Code eingefügt 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.

Parent-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 im Code Snippet Picker sowie in der Beschreibung des Codeausschnitts im Codeausschnitt-Manager angezeigt.

<Title>
    Code Snippet Title
<Title>

Parent-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 erwartete Verwendung eines Literals oder Objekts in einem Codeausschnitt, das Visual Studio beim Einfügen des Codeausschnitts in ein Projekt in einer QuickInfo anzeigt. Der QuickInfo-Text (ToolTip) wird angezeigt, wenn mit der Maus nach dem Einfügen des Codeausschnitts auf das Literal oder Objekt gezeigt wird.

<ToolTip>
    ToolTip description
</ToolTip>

Parent-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 wird zur Kennzeichnung eines vom Codeausschnitt benötigten Elements verwendet, das möglicherweise jedoch außerhalb des Codeausschnitts selbst definiert wird. Beispielsweise sollten Windows Forms-Steuerelemente, ASP.NET-Steuerelemente, Objektinstanzen und Typinstanzen als Objekte deklariert werden. Für Objektdeklarationen muss ein Typ angegeben werden. Zu diesem Zweck wird das Type-Element verwendet.

<Type>
    Type
</Type>

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

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>

Parent-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 dem Projekt der Verweis nicht hinzugefügt werden kann.

Siehe auch

Aufgaben

Exemplarische Vorgehensweise: Erstellen eines Codeausschnitts

Weitere Ressourcen

Codeausschnitte