Code-Element (IntelliSense-Codeausschnitte)

Artikel
08/10/2011

Stellt einen Container für kurze Codeblöcke von IntelliSense-Codeausschnitten bereit.

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

Attribute und Elemente

In den folgenden Abschnitten werden Attribute, untergeordnete Elemente und übergeordnete Elemente beschrieben.

Attribute

Attribute	Beschreibungen
Delimiter	Optionales Attribut. Gibt das Trennzeichen an, das zur Beschreibung von Literalen und Objekten im Code verwendet wird. Das Standardtrennzeichen ist $.
Kind	Optionales Attribut. Gibt die Art des Codes an, den der Ausschnitt enthält, sowie die daraus abgeleitete 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. Weitere Informationen finden Sie im Abschnitt "Kind-Attribut" in der folgenden Tabelle.
Language	Erforderliches Attribut. Gibt die Programmiersprache des Codeausschnitts an. Die verfügbaren Werte lauten VB, CSharp oder XML. Weitere Informationen finden Sie im Abschnitt "Language-Attribut" in der folgenden Tabelle. Hinweis Das IntelliSense-Codeausschnittschema unterstützt C++ nicht.

Delimiter

Optionales Attribut.

Gibt das Trennzeichen an, das zur Beschreibung von Literalen und Objekten im Code verwendet wird. Das Standardtrennzeichen ist $.

Kind

Optionales Attribut.

Gibt die Art des Codes an, den der Ausschnitt enthält, sowie die daraus abgeleitete 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. Weitere Informationen finden Sie im Abschnitt "Kind-Attribut" in der folgenden Tabelle.

Language

Erforderliches Attribut.

Gibt die Programmiersprache des Codeausschnitts an. Die verfügbaren Werte lauten VB, CSharp oder XML. Weitere Informationen finden Sie im Abschnitt "Language-Attribut" in der folgenden Tabelle.

Hinweis Das IntelliSense-Codeausschnittschema unterstützt C++ nicht.

Kind-Attribut

Value	Beschreibungen
method body	Gibt an, dass der Codeausschnitt Methodentext darstellt und daher in eine Methodendeklaration eingefügt werden muss.
method decl	Gibt an, dass der Codeausschnitt einer Methode entspricht und daher in eine Klasse oder in ein Modul eingefügt werden muss.
type decl	Gibt an, dass der Codeausschnitt einem Typ entspricht und daher in eine Klasse, ein Modul oder einen 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 an einer beliebigen Stelle eingefügt werden kann. Dieses Tag wird für kontextunabhängige Codeausschnitte verwendet, z. B. Kommentare.

Language-Attribut

Value	Beschreibungen
VB	Kennzeichnet einen Visual Basic-Codeausschnitt.
CSharp	Kennzeichnet einen Visual C#-Codeausschnitt.
XML	Kennzeichnet einen XML-Codeausschnitt.

Untergeordnete Elemente

Keine.

Übergeordnete Elemente

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

Textwert

Ein Textwert ist erforderlich.

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

Hinweise

Zwei reservierte Wörter sind zur Verwendung im Text des Code-Elements verfügbar: $end$ und $selected$. $end$ markiert den Speicherort, um den Cursor zu setzen, 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. Wenn beispielsweise Folgendes gegeben wäre:

$selected$ is a great color. I love $selected$.

und das Wort "Blue" würde beim Aufrufen der Vorlage ausgewählt, würden Sie Folgendes erhalten:

Blue is a great color. I love Blue.

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

Beispiel

Das Code-Element des folgenden Codeausschnitts veranschaulicht, wie ein Visual C#-Codeausschnitt geschrieben wird, durch den ein SqlDataAdapter erstellt wird. Auf das im Declarations-Element definierte Literal und Objekt wird im Code-Element durch den Wert des jeweiligen ID-Elements verwiesen. In diesem Beispiel wird auf das Literal als $SQL$ und auf das Objekt als $Connection$ verwiesen.

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Create a data adapter</Title>
            <Description>Creates a SqlDataAdapter object.</Description>
            <Author>Microsoft Corporation</Author>
            <Shortcut>createadapter</Shortcut>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>SQL</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>Connection</ID>
                    <Type>System.Data.SqlClient.SqlConnection</Type>
                    <ToolTip>Replace with a connection object in your application.</ToolTip>
                    <Default>dcConnection</Default>
                </Object>
            </Declarations>
            <Code Language="CSharp">
                <![CDATA[
                    daCustomers = new SqlClient.SqlDataAdapter();
                    selectCommand = new SqlClient.SqlCommand($SQL$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $Connection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Siehe auch

Konzepte

Schemareferenz für Codeausschnitte

Freigeben über