Tutorial: Crear un fragmento de código

  • Artículo

Puede crear un fragmento de código con solo unos pasos.Todo lo que necesita hacer es crear un archivo XML, rellene los elementos adecuados, y agregar el código.También puede agregar referencias y parámetros de reemplazo al código.Puede agregar el miniprograma a la instalación de Visual Studio mediante el botón import en el administrador de fragmentos de código (Herramientas/administrador de fragmentos de código).

SugerenciaSugerencia

Para obtener información sobre cómo escribir los fragmentos de código más fácilmente, busque el sitio Web de CodePlex para las herramientas de la comunidad Editor de fragmentos de códigocomo.

Plantilla snippet

A continuación se muestra la plantilla básica del fragmento de código:

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

para crear un fragmento de código

  1. Cree un nuevo archivo XML en Visual Studio y agregue la plantilla anterior.

  2. Complete el título snippet, eg... “Hello World VB”, en el elemento title.

  3. Complete el lenguaje del fragmento de código en el atributo de los lenguajes del elemento de código.En este ejemplo, use “VB”.

  4. Agregar código en la sección CDATA dentro del elemento de código, por ejemplo:

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

  5. Guarde el miniprograma como VBCodeSnippet.snippet.

Para agregar un fragmento de código en Visual Studio

  1. Puede agregar dispone fragmentos a la instalación de Visual Studio mediante el administrador de fragmentos de código.Abra el administrador de fragmentos de código (Herramientas/administrador de fragmentos de código).

  2. Haga clic en el botón de Importar .

  3. Vaya a la ubicación donde guardó el fragmento de código en el procedimiento anterior, seleccione, y haga clic en Abrir.

  4. El cuadro de diálogo Importar fragmento de código abra, ordenación elegir dónde agregar el fragmento de código en las opciones del panel derecho.Una de las opciones debe ser Los fragmentos de código.Selecciónelo y haga clic Finalizar, entonces Aceptar.

  5. El fragmento de código se copia en la ubicación siguiente:

    %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets

  6. Pruebe el miniprograma abrir un proyecto de Visual Basic y abre un archivo de código.Haga clic en Insertar fragmento de código de archivo en el menú contextual, entonces Los fragmentos de código.Debería ver un fragmento denominado El fragmento de código de Visual Basic.Haga doble clic en.

  7. Debería ver Console.WriteLine("Hello, World!") insertado en el código.

Campos de descripción y de acceso directo de suma

  1. Los campos de descripción proporcionan más información sobre el fragmento de código cuando se ven en el administrador de fragmentos de código.El acceso directo es una etiqueta que los usuarios pueden escribir para insertar el fragmento.Edite el fragmento de código que ha agregado abriendo el %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippetdel archivo.

  2. Agregue los elementos author y description el elemento header, y complételos.

  3. El elemento header debe tener la siguiente apariencia:

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

  4. Abra el administrador de fragmentos de código y seleccione el fragmento de código.En el panel derecho debe ver que la descripción y los campos author ahora se rellenan.

  5. Para agregar un acceso directo, agregue un elemento shortcut junto al elemento author y description:

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

  6. Guarde el archivo del miniprograma de nuevo.

  7. para probar el acceso directo, abra un proyecto de Visual Basic y abra un archivo de código.Escriba hello en TAB de archivo y presione.El código del fragmento se va a insertar.

Para agregar referencias e importaciones

  1. Con los fragmentos de código de Visual Basic puede agregar una referencia a un proyecto utilizando el elemento references, y agrega una declaración de importación mediante el elemento imports.(Los fragmentos de código en otros lenguajes no tienen esta característica). Por ejemplo, si cambia Console.WriteLine en el ejemplo de código se MessageBox.Show, puede que necesite agregar el ensamblado de System.Windows.Forms.dll al proyecto.

  2. Abra el fragmento.

  3. Agregue el elemento references bajo el elemento snippet:

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

  4. Agregue el elemento imports bajo el elemento snippet:

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

  5. Cambie la sección CDATA al siguiente:

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

  6. Guarde el fragmento.

  7. Abra un proyecto de Visual Basic y agrega el fragmento.

  8. Verá una instrucción imports al principio del archivo de código:

    Imports System.Windows.Forms

  9. Examine las propiedades del proyecto.La pestaña de las referencias incluye una referencia a System.Windows.Forms.dll.

Reemplazos de suma

  1. Puede que las partes de fragmentos de código se reemplacen por el usuario, por ejemplo si agrega una variable y desea que el usuario para reemplazar la variable con una en el proyecto actual.Puede proporcionar dos tipos de reemplazos: literales y objetos.Los literales son cadenas de algún tipo (literales de cadena, nombres de variable, o representaciones de cadena de valores numéricos).Los objetos son instancias de un tipo distinto de una cadena.En este procedimiento declarará un reemplazo literal y un reemplazo de objeto, y cambie el código para hacer referencia a estos reemplazos.

  2. Abra el fragmento.

  3. Este ejemplo utiliza una cadena de conexión SQL, por lo que necesita cambiar los elementos imports y references para agregar las referencias adecuadas:

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

  4. Para declarar un reemplazo literal para la cadena de conexión SQL, agregue un elemento declarations bajo el elemento snippet, y en ella agregue un elemento Literal con los subelementos por identificador, la información sobre herramientas, y el valor predeterminado para el reemplazo:

    <Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>

  5. Para declarar un reemplazo de objeto para la conexión de SQL, agregar un elemento de objeto dentro del elemento declarations, y agregar los subelementos por identificador, el tipo de objeto, la información sobre herramientas, y el valor predeterminado.El elemento resultante de declaraciones puede tener esta apariencia:

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

  6. En la sección de código, haga referencia a los reemplazos con el cerco de signos $, por ejemplo $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>

  7. Guarde el fragmento.

  8. Abra un proyecto de Visual Basic y agrega el fragmento.

  9. El código debe tener este aspecto, donde resaltado sustituciones cadena de conexión SQL y dcConnection en naranja claro.Presione TAB para navegar a partir de ellos.

    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

Vea también

Conceptos

Referencia de esquemas de fragmentos de código