Procedura dettagliata: creazione di un frammento di codice

Articolo
02/19/2013

È possibile creare un frammento di codice con solo alcuni passaggi.Parte dei casi è sufficiente creare un file XML, immettere gli elementi appropriati e aggiunge il codice.È anche possibile aggiungere riferimenti e i parametri sostitutivi al codice.È possibile aggiungere il frammento di installazione di Visual Studio tramite il pulsante di importazione in gestione frammenti di codice (Strumenti di gestione frammenti di codice).

Suggerimento
Per informazioni su come scrivere frammenti di codice più facilmente, individuare il sito Web CodePlex gli strumenti della community come Editor del frammento.

Modello del frammento

Ecco il modello di base del frammento:

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

Per creare un frammento di codice

Creare un nuovo file XML in Visual Studio e aggiungere il modello illustrato in precedenza.
Inserire il titolo del frammento, ad esempio.. “Hello World" VB, nell'elemento del titolo.
Inserire il linguaggio del frammento nell'attributo di linguaggi l'elemento di codice.Per questo esempio, utilizzare “VB".

Aggiungere codice nella sezione CDATA nell'elemento di codice, ad esempio:

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

Salvare il frammento come VBCodeSnippet.snippet.

Per aggiungere un frammento di codice in Visual Studio

È possibile aggiungere i propri frammenti di installazione di Visual Studio tramite gestione frammenti di codice.Aprire gestione frammenti di codice (Strumenti di gestione frammenti di codice).
Fare clic sul pulsante Importa.
Andare alla posizione in cui è stato salvato il frammento di codice nella procedura precedente, selezionarlo e fare clic su Aperto.
La finestra di dialogo Importa frammento di codice aperta, richiede di specificare dove aggiungere il frammento le opzioni nel riquadro di destra.Una delle opzioni deve essere Frammenti di codice.Selezionarla e scegliere Fine, quindi Scegliere OK.
Il frammento viene copiato nel percorso seguente:

%USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets
Testare il frammento aprendo un progetto di Visual Basic. e aprire un file di codice.Scegliere Inserisci frammento di codice del file dal menu di scelta rapida, quindi Frammenti di codice.Verrà visualizzato un frammento denominato Un frammento di codice di Visual Basic.Fare doppio clic su.
Verrà visualizzata Console.WriteLine("Hello, World!") inserito nel codice.

Descrizione di aggiunta e campi raccorciati

I campi di descrizione fornite ulteriori informazioni sul frammento di codice una volta visualizzato in gestione frammenti di codice.Il collegamento è un tag che gli utenti possono digitare per inserire il frammento.Modificare il frammento aggiunto aprendo il file %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet.
Aggiungere gli elementi di descrizione e creator all'elemento intestazione e riempiali.

L'elemento dell'intestazione dovrebbe risultare simile al seguente:

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

Aprire gestione frammenti di codice e selezionare il frammento di codice.Nel riquadro di destra verrà visualizzato nella descrizione e i campi dell'autore verranno popolati.

Per aggiungere un collegamento, aggiungere un elemento di collegamento accanto all'elemento di descrizione e dell'autore:

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

Salvare nuovamente il file frammento.
Per testare il collegamento, aprire un progetto di Visual Basic. e aprire un file di codice.Digitare hello nel file e premere TAB.Il codice dei frammenti deve essere inserito.

Per aggiungere riferimenti e le importazioni

Con frammenti di Visual Basic è possibile aggiungere un riferimento a un progetto utilizzando l'elemento di riferimenti e aggiungere una dichiarazione di importazione tramite l'elemento imports.(Frammenti in altri linguaggi non dispongono di questa funzionalità.) Ad esempio, se si modifica Console.WriteLine nell'esempio di codice a MessageBox.Show, potrebbe essere necessario aggiungere l'assembly a System.Windows.Forms.dll al progetto.
Aprire il frammento.

Aggiungere l'elemento di riferimenti sotto l'elemento del frammento:

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

Aggiungere l'elemento imports sotto l'elemento del frammento:

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

Modificare la sezione CDATA al seguente:

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

Salvare il frammento.
Aprire un progetto di Visual Basic. e aggiungere il frammento.
Verrà visualizzata un'istruzione importsinizio del file di codice:
```
Imports System.Windows.Forms
```
Esaminare le proprietà del progetto.La scheda di riferimenti include un riferimento a System.Windows.Forms.dll.

Aggiunta di sostituzioni

È possibile parti dei frammenti di codice da sostituire all'utente, ad esempio se si aggiunge una variabile e si desidera che l'utente per sostituire la variabile con una nel progetto corrente.È possibile fornire due tipi di sostituzioni: valori letterali e oggetti.I valori letterali sono stringhe di tipo (stringhe letterali, nomi di variabili, o rappresentazioni di stringa di valori numerici).Gli oggetti sono istanze di un tipo diverso da una stringa.In questa procedura viene dichiarato una sostituzione di valore letterale e una sostituzione di oggetto e il codice per fare riferimento alle sostituzioni.
Aprire il frammento.

In questo esempio viene utilizzata una stringa di connessione SQL, pertanto è necessario modificare le importazioni e fare riferimento agli elementi per aggiungere riferimenti appropriati:

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

Per dichiarare una sostituzione di valore letterale per la stringa di connessione SQL, aggiungere un elemento dichiarazioni sotto l'elemento del frammento e in aggiungere un elemento letterale con i sottoelementi per ID, la descrizione comando e il valore predefinito per la sostituzione:
```
<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>
```

Per dichiarare una sostituzione di oggetto per la connessione a SQL, aggiungere un elemento oggetto nell'elemento dichiarazioni e aggiungere i sottoelementi per l'id, il tipo di oggetto, la descrizione comando e il valore predefinito.L'elemento risultante dichiarazioni dovrebbe risultare simile al seguente:

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

Nella sezione del codice, fare riferimento alle sostituzioni con racchiudere i segni $, ad esempio $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>

Salvare il frammento.
Aprire un progetto di Visual Basic. e aggiungere il frammento.

Il codice dovrebbe essere analogo al seguente, dove le sostituzioni Stringa di connessione SQL e dcConnection sono evidenziate in arancione-chiaro.Premere TAB per passare da uno all'altro.

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

Vedere anche

Concetti

Riferimento dello schema dei frammenti di codice

Condividi tramite