Exemplarische Vorgehensweise: Erstellen eines Codeausschnitts

Artikel
06/10/2015

Ein Codeausschnitt kann in wenigen Schritten erstellt werden.Sie müssen nur eine XML-Datei erstellen, die entsprechenden Elemente eintragen und den Code hinzufügen.Dem Code können auch Verweise und Ersatzparameter hinzugefügt werden.Sie können den Codeausschnitt im Codeausschnitt-Manager über die Schaltfläche "Importieren" (Extras > Codeausschnitt-Manager) zur Visual Studio-Installation hinzufügen.

Tipp
Informationen zur einfacheren Erstellung von Codeausschnitten, beispielsweise mithilfe des Ausschnitt-Editors, finden Sie auf der CodePlex-Website für Communitytools.

Ausschnittvorlage

Im Folgenden finden Sie eine einfache Ausschnittvorlage:

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title></Title>
        </Header>
        <Snippet>
            <Code Language="">
                <![CDATA[]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

So erstellen Sie einen Codeausschnitt

Erstellen Sie eine neue XML-Datei in Visual Studio, und fügen Sie die oben gezeigten Vorlage hinzu.
Tragen Sie den Titel des Ausschnitts, z. B. "Hello World VB", in das Titelelement ein.
Tragen Sie die Sprache des Ausschnitts in das Sprachenattribut des Codeelements ein.In diesem Beispiel wird "VB" verwendet.
Fügen Sie etwas Code im CDATA-Abschnitt innerhalb des Codeelements hinzu, zum Beispiel:
```
<Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>
```
Speichern Sie den Ausschnitt als "VBCodeSnippet.snippet".

So fügen Sie einen Codeausschnitt zu Visual Studio hinzu

Sie können der Visual Studio-Installation mithilfe des Codeausschnitt-Managers eigene Ausschnitte hinzufügen.Öffnen Sie den Codeausschnitt-Manager (Extras > Codeausschnitt-Manager).
Klicken Sie auf die Schaltfläche Importieren.
Wechseln Sie zum Speicherort des Codeausschnitts aus der vorherigen Prozedur, wählen Sie diesen aus, und klicken Sie auf Öffnen.
Das Dialogfeld Codeausschnitt importieren wird geöffnet, und Sie werden aufgefordert, aus den Optionen im rechten Bereich auszuwählen, wo der Ausschnitt hinzugefügt werden soll.Die Option Meine Codeausschnitte sollte dabei zur Auswahl stehen.Wählen Sie sie aus, klicken Sie auf Fertig stellen und dann auf OK.
Der Ausschnitt wird an den folgenden Speicherort kopiert:

%USERPROFILE%\Dokumente\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippets
Testen Sie den Ausschnitt, indem Sie ein Visual Basic-Projekt und eine Codedatei öffnen.Klicken Sie in der Datei im Kontextmenü auf Ausschnitt einfügen und dann auf Meine Codeausschnitte.Sie sollten einen Ausschnitt mit dem Namen My Visual Basic Code Snippet sehen.Doppelklicken Sie darauf.
Sie sollten Console.WriteLine("Hello, World!") sehen, das in den Code eingefügt wurde.

Hinzufügen von Beschreibungs- und Verknüpfungsfeldern

Beschreibungsfelder liefern Informationen über den Codeabschnitt, wenn sie im Codeausschnitt-Manager angezeigt werden.Die Verknüpfung ist ein Tag, das Benutzer zum Einfügen Ihres Codeausschnitts eingeben können.Bearbeiten Sie den Ausschnitt, den Sie hinzugefügt haben, indem Sie die Datei %USERPROFILE%\Dokumente\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet öffnen.
Fügen Sie dem Headerelement Autor- und Beschreibungselemente hinzu, und füllen Sie diese aus.

Das Headerelement würde in etwa wie folgt aussehen:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
</Header>

Öffnen Sie den Codeausschnitt-Manager, und wählen Sie den Codeausschnitt aus.Die Beschreibungs- und Autorenfelder im rechten Bereich sollten jetzt aufgefüllt sind.

Wenn Sie eine Verknüpfung hinzufügen möchten, fügen Sie ein Verknüpfungselement zusammen mit dem Autor- und Beschreibungselement hinzu:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
    <Shortcut>hello</Shortcut>
</Header>

Speichern Sie die Ausschnittdatei erneut.
Öffnen Sie zum Testen der Verknüpfung ein Visual Basic-Projekt und eine Codedatei.Geben Sie hello in die Datei ein, und drücken Sie die TAB-TASTE.Der Ausschnittcode sollte nun eingefügt sein.

So fügen Sie Verweise und Importe hinzu

Mit Visual Basic-Ausschnitten können Sie mithilfe des Verweiselements einen Verweis auf ein Projekt und mithilfe des Import-Elements eine Import-Deklaration hinzufügen. (Ausschnitte in anderen Sprachen verfügen nicht über diese Funktion.) Wenn Sie etwa Console.WriteLine im Codebeispiel in MessageBox.Show ändern, müssen Sie möglicherweise die System.Windows.Forms.dll-Assembly zum Projekt hinzufügen.
Öffnen Sie den Ausschnitt.

Fügen Sie das Verweiselement unter dem Ausschnittelement hinzu:

<References>
    <Reference>
        <Assembly>System.Windows.Forms.dll</Assembly>
    </Reference>
</References>

Fügen Sie das Imports-Element unter dem Ausschnittelement hinzu:

<Imports>
    <Import>
       <Namespace>System.Windows.Forms</Namespace>
    </Import>
</Imports>

Ändern Sie den CDATA-Abschnitt wie folgt:

<![CDATA[MessageBox.Show("Hello, World!")]]>

Speichern Sie den Ausschnitt.
Öffnen Sie ein Visual Basic-Projekt, und fügen Sie den Ausschnitt hinzu.
Oben in der Codedatei finden Sie eine Imports-Anweisung:
```
Imports System.Windows.Forms
```
Sehen Sie sich die Eigenschaften des Projekts an.Die Registerkarte "Verweise" enthält einen Verweis auf System.Windows.Forms.dll.

Hinzufügen von Ersetzungen

Möglicherweise möchten Sie, dass Teile der Codeausschnitte vom Benutzer ersetzt werden, zum Beispiel, wenn Sie eine Variable hinzufügen und der Benutzer diese durch eine Variable aus einem aktuellen Projekt ersetzen soll.Sie können zwei Typen von Ersetzungen bereitstellen: Literale und Objekte.Literale sind Zeichenfolgen eines bestimmten Typs (Zeichenfolgenliterale, Variablennamen oder Zeichenfolgendarstellungen numerischer Werte).Objekte sind Instanzen eines Typs, der keine Zeichenfolge ist.In dieser Prozedur deklarieren Sie eine literale Ersetzung und eine Objektersetzung, und Sie ändern den Code, um auf diese Ersetzungen zu verweisen.
Öffnen Sie den Ausschnitt.

In diesem Beispiel wird eine SQL-Verbindungszeichenfolge verwendet, daher müssen Sie die Import- und Verweiselemente ändern, um die entsprechenden Verweise hinzuzufügen:

<References>
    <Reference>
        <Assembly>System.Data.dll</Assembly>
    </Reference>
    <Reference>
        <Assembly>System.Xml.dll</Assembly>
    </Reference>
</References>
<Imports>
    <Import>
        <Namespace>System.Data</Namespace>
    </Import>
    <Import>
        <Namespace>System.Data.SqlClient</Namespace>
    </Import>
</Imports>

Um eine literale Ersetzung für die SQL-Verbindungszeichenfolge zu deklarieren, fügen Sie unter dem Ausschnittelement ein Deklarationselement hinzu. Fügen Sie darin ein literales Element mit Unterelementen für die ID, die QuickInfo und den Standardwert für die Ersetzung hinzu:
```
<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>
```

Um eine Objektersetzung für die SQL-Verbindung zu deklarieren, fügen Sie innerhalb des Deklarationselements ein Objektelement und Unterelemente für die ID, den Typ des Objekts, die QuickInfo und den Standardwert hinzu.Das resultierende Deklarationselement sollte wie folgt aussehen:

<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
    <Object>
        <ID>SqlConnection</ID>
        <Type>System.Data.SqlClient.SqlConnection</Type>
        <ToolTip>Replace with a connection object in your application.</ToolTip>
        <Default>dcConnection</Default>
    </Object>
</Declarations>

Verweisen Sie im Codeabschnitt mit umgebenden $-Zeichen auf die Ersetzungen, zum Beispiel $Ersetzung$:

<Code Language="VB" Kind="method body">
    <![CDATA[Dim daCustomers As SqlDataAdapter
        Dim selectCommand As SqlCommand

        daCustomers = New SqlClient.SqlDataAdapter()
        selectCommand = new SqlClient.SqlCommand($SqlConnString$)
        daCustomers.SelectCommand = selectCommand
        daCustomers.SelectCommand.Connection = $SqlConnection$]]>
</Code>

Speichern Sie den Ausschnitt.
Öffnen Sie ein Visual Basic-Projekt, und fügen Sie den Ausschnitt hinzu.

Der Code sollte wie folgt aussehen, wobei die Ersetzungen SQL connection string und dcConnection in hellem Orange hervorgehoben sind.Drücken Sie die TAB-TASTE, um von einem Ausschnitt zum anderen zu navigieren.

Dim daCustomers As SqlDataAdapter
Dim selectCommand As SqlCommand

daCustomers = New SqlClient.SqlDataAdapter()
selectCommand = New SqlClient.SqlCommand("SQL connection string")
daCustomers.SelectCommand = selectCommand
daCustomers.SelectCommand.Connection = dcConnection

Siehe auch

Konzepte

Schemareferenz für Codeausschnitte

Freigeben über