Wskazówki: tworzenie wstawek kodu

Artykuł
06/10/2015

Można tworzyć fragment kodu tylko za pomocą kilku kroków.Twoim zadaniem jest tworzenie pliku XML, wypełnianie odpowiednich elementów i dodawanie do nich kodu.Można również dodać do kodu parametry odwołań i zastąpień.Można dodać fragment kodu do instalacji programu Visual Studio za pomocą przycisku Importuj w Menedżerze fragmentów kodu (Narzędzia/Menedżer fragmentów kodu).

Porada
Aby dowiedzieć się, jak łatwiej napisać wstawki kodu programu, wyszukaj w witrynie CodePlex narzędzi społecznościowe, takie jak Edytor wstawek.

Szablon fragmentu kodu

Oto podstawowy szablon fragmentu kodu:

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

Aby utworzyć wstawkę kodu

Utwórz nowy plik XML w programie Visual Studio i dodaj ukazany powyżej szablon.
Wprowadź tytuł wstawki, np. „Witaj Świecie VB”, w elemencie Tytuł.
Wprowadź język wstawki w elemencie Kod w atrybucie Języki.W tym przykładzie należy użyć „VB”.

Dodaj jakiś kod w sekcji CDATA wewnątrz elementu kodu, na przykład:

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

Zapisz fragment kodu jako VBCodeSnippet.snippet.

Aby dodać wstawki kodu do programu Visual Studio

Można dodawać własne fragmenty kodu do instalacji programu Visual Studio za pomocą Menedżera fragmentów kodu.Otwórz Menedżera wstawek kodu (Narzędzia/Manager wstawek kodu).
Kliknij przycisk Importuj.
Przejdź do lokalizacji, w której została zapisana wstawka kodu w poprzedniej procedurze, zaznacz ją i kliknij przycisk Otwórz.
Zostanie otwarte okno dialogowe Importowanie fragmentu kodu z monitem o wybranie miejsca dodania fragmentu kodu spośród możliwości w okienku po prawej stronie.Jedną z opcji powinny być Moje wstawki kodu programu.Zaznacz go i kliknij przycisk Zakończ, a następnie OK.
Fragment kodu zostanie skopiowany do następującej lokalizacji:

%USERPROFILE%\Documents\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippets
Przetestuj swój fragment kodu, otwierając projekt Visual Basic, a następnie plik kodu.W pliku, kliknij przycisk Wstaw fragment w menu kontekstowym, a następnie Moje fragmenty kodu.Powinieneś zobaczyć fragment o nazwie Moja wstawka kodu programu Visual Basic.Kliknij dwukrotnie.
Powinieneś zobaczyć Console.WriteLine("Hello, World!") wstawione w kodzie.

Dodawanie pól Opis i Skrót

Pola opisów podać więcej informacji na temat fragmentów kodu po wyświetleniu w Menedżerze fragmentów kodu.Skrót jest znacznikiem, który użytkownicy mogą wpisać w celu wstawienia fragmentu kodu.Edytuj dodaną wstawkę, otwierając plik %USERPROFILE%\Documents\Visual Studio 2013\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet.
Dodaj elementy Autor i Opis do elementu Nagłówek, i wypełnij je.

Element nagłówka powinien wyglądać następująco:

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

Otwórz Menedżera wstawek kodu i wybierz wstawki kodu.W okienku po prawej stronie powinieneś zobaczyć, że teraz zostaną wypełnione pola Opis i Autor.

Aby dodać skrót, dodaj element skrótu obok elementu Autor i opis:

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

Zapisz ponownie plik fragmentu kodu.
Aby przetestować ten skrót, należy otworzyć projekt języka Visual Basic i otwórz plik kodu.Wpisz hello w pliku i naciśnij klawisz TAB.Należy wstawić fragment kodu.

Aby dodać odwołania i importy

Za pomocą fragmentów kodu Visual Basic możliwe jest dodawanie odwołań do projektu przy użyciu elementu Odwołania i dodawanie deklaracji Importy za pomocą elementu Importy. (Fragmenty w innych językach nie posiadają tej funkcji.) Na przykład jeśli zmienisz element Console.WriteLine w przykładzie kodu na MessageBox.Show, konieczne może być dodanie zestawu System.Windows.Forms.dll do projektu.
Otwórz swoją wstawkę.

Dodaj element Odwołania pod elementem Fragment kodu:

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

Dodaj element Importy pod elementem Fragment kodu:

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

Zmień sekcję CDATA w następujący sposób:

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

Zapisz fragment kodu.
Otwórz projekt programu Visual Basic i dodaj fragment kodu.
Wyświetlona zostanie instrukcja Imports u góry pliku kodu:
```
Imports System.Windows.Forms
```
Przyjrzyj się właściwościom projektu.Karta Odwołania zawiera odwołanie do pliku System.Windows.Forms.dll.

Dodawanie zamian

Możesz zdecydować o wymianie części swoich wstawek kodu programu przez użytkownika, na przykład jeśli dodasz zmienną i chcesz, żeby użytkownik zastąpił ją zmienną w bieżącym projekcie.Można zapewnić dwa rodzaje zamiany: literalne lub obiektowe.Literały są ciągami specjalistycznymi (literały ciągów znaków, nazwy zmiennych lub ciągi znaków reprezentujące wartości liczbowe).Obiekty są wystąpieniami niektórych typów innych niż ciąg.W tej procedurze zostanie zadeklarowana wymiana literału i zastąpienie obiektu oraz zmiana kodu, aby odwołać te zmiany.
Otwórz swoją wstawkę.

W tym przykładzie użyto parametrów połączenia SQL, dlatego należy zmienić elementy Importy i Odwołania, aby dodać odpowiednie odwołania:

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

Aby zadeklarować zamianę literału dla parametrów połączenia SQL, dodaj element deklaracji pod elementem wstawki kodu, a w nim dodaj element literału z podelementami dla identyfikatora, wskazówki i wartości domyślnej do zastąpienia:
```
<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>
```

Aby zadeklarować zamianę obiektu dla połączenia SQL, dodaj element obiektu wewnątrz elementu deklaracji i dodaj elementy podrzędne dla identyfikatora, typu obiektu, wskazówki oraz wartości domyślnej.Wynikowy element Declarations powinien wyglądać następująco:

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

W sekcji kodu można odwołać się do zamian z otaczającymi znakami $, na przykład $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>

Zapisz fragment kodu.
Otwórz projekt programu Visual Basic i dodaj fragment kodu.

Kod powinien wyglądać jak poniżej, gdzie zamiany Parametry połączenia SQL i dcConnection są wyróżnione kolorem jasnopomarańczowym.Naciśnij klawisz TAB, aby przejść z jednego do drugiego.

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

Zobacz też

Koncepcje

Fragmenty kodu — Odwołanie do schematu

Udostępnij za pośrednictwem