Gewusst wie: Erstellen eines grundlegenden Codeausschnitts

Artikel
09/02/2008

Aktualisiert: November 2007

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 SNIPPET-Datei

Bevor Sie mit dem Schreiben des Codeausschnitts beginnen, müssen Sie eine XML-Datei mit der Dateinamenerweiterung .snippet erstellen.

So erstellen Sie eine SNIPPET-Datei

Klicken Sie im Menü Datei auf Neu und dann auf Datei.
Klicken Sie auf XML-Datei und dann auf Öffnen.
Klicken Sie im Menü Datei auf <XML-Dateiname> speichern.
Wählen Sie im Feld Dateityp die Option Alle Dateien (*.*).
Geben Sie im Feld Dateiname einen Dateinamen mit der Dateinamenerweiterung .snippet ein.
Klicken Sie auf Speichern.

Schreiben des Codes

Nachdem Sie jetzt über eine XML-Datei verfügen, müssen Sie den XML-Code schreiben, aus dem sich der Codeausschnitt zusammensetzt. Weitere Informationen zu den in den folgenden Beispielen verwendeten XML-Elementen finden Sie unter Schemareferenz für Codeausschnitte.

So schreiben Sie den Code für den Codeausschnitt

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>
```
Hinweis:

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

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

Hinweis:
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>

Nun können Sie diesen IntelliSense-Codeausschnitt in Visual Studio 2005 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. Da Visual C#-Codeausschnitte keine Unterstützung für den References-Abschnitt bieten, muss dem Projekt ein Verweis auf System.Windows.Forms.dll manuell hinzugefügt werden.

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