Exemplarische Vorgehensweise: Erstellen eines Codeausschnitts

Artikel
02/26/2013

Sie können einen Codeausschnitt mit nur einigen Schritten erstellt.Alles, was Sie tun müssen, besteht darin, eine XML-Datei zu erstellen, die entsprechenden Elemente auszufüllen, und den Code hinzufügen.Sie können Verweise und Ersatzparameter an Code hinzufügen.Sie können den Ausschnitt der Visual Studio-Installation hinzufügen, indem Sie die Importschaltfläche auf dem Codeausschnitt-Manager (Extras/Codeausschnitt-Manager) verwenden.

Tipp
Informationen darüber, wie Codeausschnitte leicht, suchen Sie die CodePlex-Website für Communitytools wie Ausschnitts-Editor schreibt.

Ausschnitts-Vorlage

Im Folgenden ist die grundlegende Ausschnittsvorlage:

<?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 fügen Sie einen Codeausschnitt erstellen

Erstellen Sie eine neue XML-Datei in Visual Studio und fügen Sie die Vorlage hinzu, die oben angezeigt wird.
Füllen Sie den Titel des Ausschnitts, z... world-VB "Hello", im Titelelement aus.
Füllen Sie die Sprache des Ausschnitts im Sprachattribut des Codeelements aus.Verwenden Sie beispielsweise "VB".
Fügen Sie Code im CDATA-Abschnitt innerhalb des Codeelements, zum Beispiel hinzu:
```
<Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>
```
Speichern Sie den Ausschnitt als VBCodeSnippet.snippet.

So fügen Sie einen Codeausschnitt Visual Studio hinzufügen

Sie können eigene Ausschnitte der Visual Studio-Installation hinzufügen, indem Sie den Codeausschnitt-Manager verwenden.Öffnen Sie den Codeausschnitt-Manager (Extras/Codeausschnitt-Manager).
Klicken Sie auf die Schaltfläche Importieren.
Wechseln Sie zu der Position, an der der Codeausschnitt in der vorherigen Prozedur gespeichert, sie auswählen und auf Öffnen klicken.
Das Dialogfeld wird geöffnet Codeausschnitt importieren und fordert Sie, auszuwählen, wo der Ausschnitt aus den Optionen im rechten Bereich hinzufügt.Eine der Optionen sollte Meine Codeausschnitte sein.Wählen Sie es aus und klicken Sie auf Fertig stellen, dann OK.
Der Ausschnitt wird mit dem folgenden Speicherort kopiert:

%USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets
Testen Sie den Ausschnitt, indem Sie ein Visual Basic-Projekt öffnen und eine Codedatei öffnen.Im Dateiklick Ausschnitt einfügen im Kontextmenü, dann Meine Codeausschnitte.Sie sollten einen Ausschnitt finden, der Mein Visual Basic-Codeausschnitt genannt wird.Doppelklicken Sie auf diesen.
Sie sollten Console.WriteLine("Hello, World!") finden, das in den Code eingefügt wird.

Hinzufügen von Beschreibungs- und Verknüpfungs-Feldern

Textfelder geben mehr Informationen über den Codeausschnitt, wenn sie im Codeausschnitt-Manager angezeigt werden.Die Verknüpfung ist ein Tag, das Benutzer eingeben können, um den Ausschnitt einzufügen.Bearbeiten Sie den Ausschnitt, den Sie hinzugefügt haben, indem Sie die Datei %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet geöffnet haben.
Fügen Sie Beschreibungselemente Kombination und dem Headerelement hinzu, und füllen Sie sie aus.

Das Headerelement sollte etwa folgendermaßen 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.Im rechten Bereich sollten Sie sehen, dass die Beschreibungs- und Autorenfelder jetzt gefüllt werden.

Um eine Verknüpfung hinzuzufügen, fügen Sie ein das Shortcut-Element neben dem Kombination 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.
Um die Verknüpfung zu testen, öffnen Sie ein Visual Basic-Projekt und öffnen Sie eine Codedatei.Geben Sie Hello in der Datei und Sie " ein.Der Ausschnittscode sollte eingefügt werden.

So fügen Sie Verweise und Importe hinzufügen

Mit Visual Basic-Ausschnitten können Sie einen Verweis auf ein Projekt, indem Sie das Bezugselement hinzufügen verwenden, und fügen eine Einfuhrzollanmeldung hinzu, indem Sie das Importelement verwenden.(Ausschnitte in anderen Sprachen verfügen diese Funktion nicht.) Wenn Sie beispielsweise Console.WriteLine im Codebeispiel zu MessageBox.Show ändern, müssen Sie die System.Windows.Forms.dll-Assembly dem Projekt hinzufügen.
Öffnen Sie den Ausschnitt.

Fügen Sie das Bezugselement unter dem Ausschnittselement hinzu:

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

Fügen Sie das Importelement unter dem Ausschnittselement hinzu:

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

Ändern Sie den CDATA-Abschnitt folgendermaßen:
```
<![CDATA[MessageBox.Show("Hello, World!")]]>
```
Speichern Sie den Ausschnitt.
Öffnen Sie ein Visual Basic-Projekt und fügen Sie den Ausschnitt hinzu.
Sie sehen eine Importanweisung am Anfang der Codedatei:
```
Imports System.Windows.Forms
```
Betrachten Sie die Eigenschaften des Projekts.Die Bezugsregisterkarte enthält einen Verweis auf System.Windows.Forms.dll.

Hinzufügen der Ersetzungen

Sie sollten Teile der Codeausschnitte vom Benutzer ersetzt werden, wenn Sie eine Variable hinzufügen und den Benutzer die Variable von einer im aktuellen Projekt ersetzen soll.Sie können zwei Typen jeweiligen Ersatz bereitstellen: Literale und Objekte.Literale sind Zeichenfolgen eines Typs (Zeichenfolgenliterale, Variablennamen oder Zeichenfolgendarstellungen numerischer Werte).Objekte sind Instanzen eines Typs anders als eine Zeichenfolge.In dieser Prozedur deklarieren Sie eine literale Ersetzung und eine Objektersetzung und ändern den Code, um die jeweiligen Ersatz zu verweisen.
Öffnen Sie den Ausschnitt.

In diesem Beispiel wird eine SQL-Verbindungszeichenfolge, müssen Sie die Importe ändern und Elemente verweisen, 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 einen literalen Ersetzung für die SQL-Verbindungszeichenfolge zu deklarieren, fügen Sie ein Deklarationselement unter dem Ausschnittselement hinzu, und fügen Sie ihn in ein literales Element mit Unterelementen für die ID, die QuickInfo und der 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 deklarieren, ein Objektelement innerhalb des Deklarationselements hinzufügen, und Unterelemente für die ID, den Typ des Objekts, die QuickInfo und Standardwert hinzufügen.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>

Im Codeabschnitt verweisen Sie auf die jeweiligen Ersatz mit dem Schließen von $-Zeichen, beispielsweise $replacement$:

<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, wo die jeweiligen Ersatz SQL-Verbindungszeichenfolge und dcConnection in Hellorangeem hervorgehoben werden.Drücken Sie TAB, um von einer zur 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