Cómo: Crear un fragmento de código básico

Artículo
08/10/2011

Los fragmentos de código de IntelliSense son archivos XML con la extensión .snippet que son conformes al esquema XML de fragmentos de código de IntelliSense. En este tema, creará un fragmento de código básico que muestra un cuadro de mensaje. Para obtener más información sobre el esquema XML de fragmentos de código, vea Referencia de esquemas de fragmentos de código.

Crear un archivo snippet

Para crear un archivo snippet, debe crear un archivo XML y, a continuación, escribir el código XML que compone el fragmento de código. Para obtener más información sobre cualquiera de los elementos XML utilizados en los ejemplos siguientes, vea Referencia de esquemas de fragmentos de código.

Para crear un archivo snippet

Cree un archivo XML y, a continuación, ábralo en el editor.
Debajo de la línea de XML que se genera automáticamente, agregue un elemento CodeSnippets con el valor correcto del atributo xmlns y un elemento CodeSnippet, a fin de crear un fragmento de código individual. Por ejemplo:
```
<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
```
Agregue una sección de encabezado al fragmento de código. Por ejemplo:
```
<Header>
    <Title>
        My Snippet
    </Title>
</Header>
```
Agregue los elementos que definen el propio fragmento de código. En el ejemplo siguiente, el lenguaje del fragmento de código es Visual Basic.
```
<Snippet>
    <Code Language="VB">

    </Code>
</Snippet>
```
Nota

El atributo Language también acepta los valores CSharp, VJSharp y XML. Para obtener más información, consulte Code (Elemento, fragmentos de código IntelliSense).
Dentro del elemento Code, agregue el código de Visual Basic del fragmento. El código del fragmento completo se debe colocar entre corchetes <![CDATA[ y ]]>. En el ejemplo siguiente, el código que se insertará es MessageBox.Show("Hello World").
```
<Code Language="VB">
    <![CDATA[MessageBox.Show("Hello World")]]>
</Code>
```
Dentro del elemento Snippet, agregue el elemento References y todos los elementos secundarios requeridos que agregan una referencia al proyecto cuando se inserta el fragmento de código. En este ejemplo, el fragmento de código agrega una referencia a System.Windows.Forms.dll cuando se inserta.

Nota

Sólo los fragmentos de código de Visual Basic admiten la sección References. Los fragmentos de código en otros lenguajes requieren que se agreguen las referencias correctas manualmente.
```
<Snippet>
    <References>
        <Reference>
            <Assembly>System.Windows.Forms.dll</Assembly>
        </Reference>
    </References>
    <Code Language="VB">
        <![CDATA[MessageBox.Show("Hello World")]]>
    </Code>
</Snippet>
```
En el menú Archivo, haga clic en Guardar <nombreArchivo> como… y guarde el archivo con la extensión .snippet.

Puede usar este fragmento de código de IntelliSense en Visual Studio; para ello, siga los procedimientos de Cómo: Administrar fragmentos de código y Cómo: Insertar fragmentos de código de IntelliSense.

Ejemplo

Este ejemplo contiene el fragmento de código de IntelliSense completo creado en los pasos anteriores.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>System.Windows.Forms.dll</Assembly>
                </Reference>
            </References>
            <Code Language="VB">
                <![CDATA[MessageBox.Show("Hello World")]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Este ejemplo contiene la versión para Visual C# del fragmento de código de IntelliSense creado en los pasos anteriores. Los fragmentos de código de Visual C# no admiten la sección References, de modo que es necesario agregar manualmente al proyecto una referencia a System.Windows.Forms.dll.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <Code Language="CSharp">
                <![CDATA[MessageBox.Show("Hello World");]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Vea también

Referencia

Crear fragmentos de código

Crear y utilizar fragmentos de código de IntelliSense

Conceptos

Referencia de esquemas de fragmentos de código

Compartir a través de