Návod: Vytvoření fragmentu kódu

Článek
06/10/2015

Pomocí několika kroků můžete vytvořit fragment kódu.Vše, co potřebujete udělat, je vytvořit soubor XML, vyplnit odpovídající prvky a přidat do něj kód.Ke svému kódu také můžete přidat odkazy a náhradní parametry.Výstřižek můžete přidat do instalace aplikace Visual Studio pomocí tlačítka importovat ve Správce fragmentů kódů (Nástroje/Správce fragmentů kódů).

Tip

Informace o snadnějším psaní fragmentů kódu vyhledejte na webu CodePlex komunitní nástroje, jako je např. Editor fragmentů.

Šablona fragmentu

Šablona základního fragmentu je následující:

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

Vytvoření fragmentu kódu

Vytvořte nový soubor XML v aplikaci Visual Studio a přidejte výše uvedenou šablonu.
Vyplňte název fragmentu kódu, např. „Hello World VB“ do prvku Název.
Vyplňte jazyk fragmentu kódu do atributu Jazyky prvku Kód.V tomto příkladu použijte „VB“.

Přidat nějaký kód do oddílu CDATA uvnitř prvku Kód, například:

<Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>

Výstřižek uložte jako VBCodeSnippet.snippet.

Přidání fragmentu kódu do sady Visual Studio

Můžete přidat vlastní výstřižky do instalace aplikace Visual Studio pomocí Správce fragmentů kódů.Otevřete Správce fragmentů kódů (Nástroje / Správce fragmentů kódů).
Klikněte na tlačítko Importovat.
Přejděte do umístění s uloženým fragmentem kódu z předchozího postupu, vyberte jej a klikněte na tlačítko Otevřít.
Import kódu otevře dialogové okno s výzvou k volbě, zda chcete-li přidat výstřižku z nabídky v pravém podokně.Jedna z možností by měla být Moje fragmenty kódu.Vyberte ji a klikněte na Dokončit, OK.
Fragment je zkopírován do následujícího umístění:

%USERPROFILE%\Documents\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippets
Otestujte fragment otevřením projektu jazyka Visual Basic a otevřete soubor s kódem.V souboru klikněte na možnost Vložit fragment v kontextové nabídce a potom na možnost Mé fragmenty kódu.Měli byste vidět fragment kódu s názvem Můj fragment kódu jazyka Visual Basic.Poklepejte na něj.
Měli byste vidět Console.WriteLine("Hello, World!") vložený v kódu.

Přidání polí Popis a Zástupce

Popisná pole poskytují další informace o fragmentech kódů při zobrazení ve Správci fragmentů kódů.Zástupce je příznak, který mohou uživatelé zadat, aby vložili váš fragment.Upravte fragment kódu přidaný otevřením souboru %USERPROFILE%\Documents\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet.
Přidejte prvky Autor a Popis do prvku Záhlaví a vyplňte je.

Prvek Header by měl vypadat přibližně takto:

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

Otevřete Správce fragmentů kódů a vyberte váš fragment kódu.V pravém podokně byste měli vidět, že pole Popis a Autor jsou nyní zaplněna.

Chcete-li přidat zástupce, přidejte prvek zástupce spolu s prvkem Autor a Popis:

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

Znovu uložte soubor výstřižku.
Chcete-li otestovat zástupce, otevřete projekt jazyka Visual Basic a otevřete soubor kódu.Zadejte ahoj do souboru a stiskněte klávesu TAB.Kódu fragmentu musí být zařazen.

Přidání odkazů a importů

Pomocí fragmentů kódu jazyka Visual Basic můžete přidat odkaz na projekt pomocí elementu Odkazy a přidat deklaraci na importy pomocí elementu Importy. (Fragmenty v jiných jazycích tuto funkci nemají.) Například pokud změníte Console.WriteLine v příkladu kódu na MessageBox.Show, budete muset přidat do projektu sestavení System.Windows.Forms.dll.
Otevřete fragment.

Přidejte prvek Odkazy pod prvek Fragment:

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

Přidejte prvek Importy pod prvek Fragment:

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

Změňte oddíl CDATA následujícím způsobem:
```
<![CDATA[MessageBox.Show("Hello, World!")]]>
```
Uložte výstřižek.
Otevřete projekt aplikace Visual Basic a přidejte fragment.
Zobrazí se příkaz Importy v horní části souboru kódu:
```
Imports System.Windows.Forms
```
Podívejte se na vlastnosti projektu.Karta Odkazy obsahuje odkaz na System.Windows.Forms.dll.

Přidání nahrazení

Můžete chtít, aby fragmenty kódu nahradil uživatel, například pokud přidáte proměnnou a chcete, aby ji uživatel nahradil v aktuálním projektu za jinou.Můžete poskytnout dva druhy náhrad: literály a objekty.Literály jsou řetězce nějakého typu (řetězcové literály, názvy proměnných nebo řetězcové reprezentace číselných hodnot).Objekty jsou instancemi jiného typu než řetězce.V tomto postupu deklarujete náhradní literál a náhradní objekt a změníte kód, který se na tyto náhrady odkazuje.
Otevřete fragment.

Tento příklad využívá připojovací řetězec SQL, takže musíte změnit prvky Importy a Odkazy pro přidání příslušných odkazů:

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

Chcete-li deklarovat literální nahrazení pro řetězec připojení SQL, přidejte prvek Deklarace pod prvek fragment a do něj přidejte prvek Literál s podprvky pro identifikátor, popisek a výchozí hodnotu pro nahrazení:
```
<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>
```

Chcete-li deklarovat nahrazení objektu pro připojení SQL, přidejte prvek objektu dovnitř prvku Deklarace a přidejte podprvky pro identifikátor, typ objektu, popisek a výchozí hodnotu.Výsledný prvek deklarace by měl vypadat takto:

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

V části kódu se odkazujete na záměny obklopením znaky $, například $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>

Uložte výstřižek.
Otevřete projekt aplikace Visual Basic a přidejte fragment.

Kód by měl vypadat následovně, kde záměny Připojovací řetězec SQL a dcConnection jsou zvýrazněny světle oranžově.Stisknutím klávesy TAB přejděte od jednoho k druhému.

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

Viz také

Koncepty

Fragmenty kódu – odkaz schématu

Sdílet prostřednictvím