Gewusst wie: Erstellen eines grundlegenden Codeausschnitts

Artikel
08/10/2011

Bei IntelliSense-Codeausschnitten handelt es sich um XML-Dateien mit der Dateinamenerweiterung .snippet, die dem XML-Schema für IntelliSense-Codeausschnitte entsprechen. In diesem Thema erstellen Sie einen grundlegenden Codeausschnitt, durch den ein Meldungsfeld angezeigt wird. Weitere Informationen zum XML-Schema für Codeausschnitte finden Sie unter Schemareferenz für Codeausschnitte.

Erstellen einer Ausschnittdatei

Zum Erstellen einer Ausschnittdatei müssen Sie eine XML-Datei erstellen und anschließend den XML-Code schreiben, aus dem der Codeausschnitt besteht. Weitere Informationen zu den in den folgenden Beispielen verwendeten XML-Elementen finden Sie unter Schemareferenz für Codeausschnitte.

So erstellen Sie eine Ausschnittdatei

Erstellen Sie eine XML-Datei, und öffnen Sie sie anschließend im Editor.
Fügen Sie unterhalb der automatisch generierten XML-Zeile ein CodeSnippets-Element mit dem geeigneten xmlns-Attributwert und ein CodeSnippet-Element ein, um einen einzelnen Codeausschnitt zu erstellen. Beispiel:
```
<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
```
Fügen Sie dem Codeausschnitt einen Headerabschnitt hinzu. Beispiel:
```
<Header>
    <Title>
        My Snippet
    </Title>
</Header>
```
Fügen Sie die Elemente hinzu, durch die der Codeausschnitt selbst definiert wird. Im folgenden Beispiel wird der Codeausschnitt in der Sprache Visual Basic geschrieben.
```
<Snippet>
    <Code Language="VB">

    </Code>
</Snippet>
```
Tipp

Für das Language-Attribut können auch die Werte CSharp, VJSharp und XML verwendet werden. Weitere Informationen finden Sie unter Code-Element (IntelliSense-Codeausschnitte).
Fügen Sie im Code-Element den Visual Basic-Code für den Ausschnitt hinzu. Der gesamte Ausschnittcode muss zwischen <![CDATA[- und ]]>-Klammern platziert werden. Im folgenden Beispiel lautet der eingefügte Code MessageBox.Show("Hello World").
```
<Code Language="VB">
    <![CDATA[MessageBox.Show("Hello World")]]>
</Code>
```
Fügen Sie innerhalb des Snippet-Elements das References-Element mit allen erforderlichen untergeordneten Elementen hinzu, durch die dem Projekt beim Einfügen des Ausschnitts ein Verweis hinzugefügt wird. In diesem Beispiel fügt der Codeausschnitt einen Verweis auf System.Windows.Forms.dll hinzu, wenn der Ausschnitt eingefügt wird.

Tipp

Nur Visual Basic-Codeausschnitte unterstützen den References-Abschnitt. Bei Codeausschnitten in anderen Programmiersprachen müssen die korrekten Verweise manuell hinzugefügt werden.
```
<Snippet>
    <References>
        <Reference>
            <Assembly>System.Windows.Forms.dll</Assembly>
        </Reference>
    </References>
    <Code Language="VB">
        <![CDATA[MessageBox.Show("Hello World")]]>
    </Code>
</Snippet>
```
Klicken Sie im Menü Datei auf <Dateiname> speichern unter, und speichern Sie die Datei mit der Erweiterung ".snippet".

Sie können diesen IntelliSense-Codeausschnitt in Visual Studio verwenden, indem Sie die Verfahren unter Gewusst wie: Verwalten von Codeausschnitten und Gewusst wie: Einfügen von IntelliSense-Codeausschnitten ausführen.

Beispiel

Dieses Beispiel enthält den gesamten in den vorherigen Schritten erstellten IntelliSense-Codeausschnitt.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>System.Windows.Forms.dll</Assembly>
                </Reference>
            </References>
            <Code Language="VB">
                <![CDATA[MessageBox.Show("Hello World")]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Dieses Beispiel enthält eine Visual C#-Version des in den vorherigen Schritten erstellten IntelliSense-Codeausschnitts. Visual C#-Codeausschnitte bieten keine Unterstützung für den References-Abschnitt, sodass ein Verweis auf "System.Windows.Forms.dll" dem Projekt manuell hinzugefügt werden muss.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <Code Language="CSharp">
                <![CDATA[MessageBox.Show("Hello World");]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Siehe auch

Referenz

Erstellen von Codeausschnitten

Erstellen und Verwenden von IntelliSense-Codeausschnitten

Konzepte

Schemareferenz für Codeausschnitte

Freigeben über