Tutorial: Creación de un fragmento de código en Visual Studio

Puede aumentar la productividad y la confiabilidad mediante fragmentos de código para reducir el tiempo dedicado a escribir código repetitivo o buscar ejemplos. Los fragmentos de código son fragmentos de código autenticados previamente que están listos para insertarse en la aplicación.

Puede crear sus propios fragmentos de código y agregarlos a los fragmentos de código que Visual Studio ya incluye. En este artículo se explica cómo crear un fragmento de código en unos pocos pasos. Cree un archivo XML, rellene los elementos adecuados y agregue el código al archivo. Opcionalmente, puede usar parámetros de reemplazo y referencias de proyecto. A continuación, importará el fragmento de código a la instalación de Visual Studio.

Creación de un fragmento de código

1. Abra Visual Studio y seleccione Continuar sin código en la pantalla Inicio .

   

2. En la barra de menús, seleccione Archivo>nuevo archivo o escriba Ctrl+N.

3. En el cuadro de diálogo Nuevo archivo , seleccione Archivo XML y, a continuación, seleccione Abrir.

   

4. Pegue la siguiente plantilla de fragmento de código básica en el editor de código.

   <?xml version="1.0" encoding="utf-8"?>
   <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
       <CodeSnippet Format="1.0.0">
           <Header>
               <Title></Title>
           </Header>
           <Snippet>
               <Code Language="">
                   <![CDATA[]]>
               </Code>
           </Snippet>
       </CodeSnippet>
   </CodeSnippets>
   

5. Escriba el título Raíz cuadrada en el elemento de fragmento de código Title .

6. En el Language atributo del Code elemento, rellene CSharp para un fragmento de código de C# o VB para Visual Basic.

   Sugerencia

   Para ver todos los valores de idioma disponibles, consulte Atributos en la referencia de esquema de fragmentos de código.

7. Agregue el siguiente código de fragmento de código a la CDATA sección dentro del Code elemento .

   Para C#:

       <![CDATA[double root = Math.Sqrt(16);]]>
   

   Para Visual Basic:

       <![CDATA[Dim root = Math.Sqrt(16)]]>
   

   Nota:

   No se puede especificar cómo dar formato o aplicar sangría a líneas de código en la CDATA sección de un fragmento de código. Tras la inserción, el servicio de lenguaje da formato al código insertado automáticamente.

8. Guarde el fragmento de código en cualquier lugar como SquareRoot.snippet.

Importación del fragmento de código

1. Para importar el fragmento de código a la instalación de Visual Studio, seleccione Herramientas Administrador> defragmentos de código o presione Ctrl+K, B.

2. En el Administrador de fragmentos de código, seleccione el botón Importar .

3. Vaya a la ubicación del fragmento de código, selecciónelo y seleccione Abrir.

4. En el cuadro de diálogo Importar fragmento de código , seleccione la carpeta Mis fragmentos de código en el panel derecho. Seleccione Finalizar y luego seleccione Aceptar.

   El fragmento de código se copia en una de las siguientes ubicaciones, en función del lenguaje de código:

   • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual C#\My Code Snippets
   • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual Basic\My Code Snippets

5. Pruebe el fragmento de código abriendo un proyecto de C# o Visual Basic. Con un archivo de código abierto en el editor, realice una de las siguientes acciones:

   • En la barra de menús de Visual Studio, elija Editar>intelliSense>Insertar fragmento de código.
   • Haga clic con el botón derecho y elija Insertar fragmento> decódigo en el menú contextual.
   • En el teclado, presione Ctrl+K, X.

6. Abra Mis fragmentos de código y haga doble clic en el fragmento denominado Raíz cuadrada. El código de fragmento de código se inserta en el archivo de código.

Campos de descripción y acceso directo

El campo description proporciona más información sobre el fragmento de código cuando se ve en el Administrador de fragmentos de código. El acceso directo es una etiqueta que puede escribir para insertar el fragmento de código.

1. Para editar el fragmento de código, abra el archivo de fragmento de código desde una de las siguientes ubicaciones, en función del lenguaje de código:

   • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual C#\My Code Snippets/SquareRoot.snippet
   • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual Basic\My Code Snippets/SquareRoot.snippet

   Sugerencia

   Dado que está editando el archivo en el directorio donde Visual Studio lo colocó, no es necesario volver a importarlo a Visual Studio.

2. Agregue Authorelementos , Descriptiony Shortcut al Header elemento y llenelos.

3. Confirme que el Header elemento es similar al ejemplo siguiente y guarde el archivo.

   <Header>
       <Title>Square Root</Title>
       <Author>Myself</Author>
       <Description>Calculates the square root of 16.</Description>
       <Shortcut>sqrt</Shortcut>
   </Header>
   

4. Abra el Administrador de fragmentos de código de Visual Studio Code y seleccione el fragmento de código. En el panel derecho, observe que los campos Descripción, Autor y Acceso directo ahora se rellenan.

   

5. Para probar el acceso directo, abra el proyecto que usó anteriormente, escriba sqrt en el editor y presione Tab una vez para Visual Basic o dos veces para C#. El código de fragmento de código se inserta.

Parámetros de reemplazo

Es posible que desee que el usuario reemplace partes de un fragmento de código. Por ejemplo, es posible que desee que el usuario reemplace un nombre de variable por uno en su proyecto actual.

Puede proporcionar dos tipos de reemplazos: literales y objetos.

• Use el elemento Literal para identificar un reemplazo de código completamente contenido en el fragmento de código que se puede personalizar después de insertarse en el código. Por ejemplo, una cadena o un valor numérico.

• Use el elemento Object para identificar un elemento que requiere el fragmento de código, pero probablemente esté definido fuera del fragmento de código. Por ejemplo, una instancia de objeto o un control .

Puede usar un Literal elemento en el archivo SquareRoot.snippet para ayudar a los usuarios a cambiar fácilmente el número para calcular la raíz cuadrada de .

1. En el archivo SquareRoot.snippet , modifique el elemento de la Snippet siguiente manera:

   <Snippet>
     <Code Language="CSharp">
       <![CDATA[double root = Math.Sqrt($Number$);]]>
     </Code>
     <Declarations>
       <Literal>
         <ID>Number</ID>
         <ToolTip>Enter the number you want the square root of.</ToolTip>
         <Default>16</Default>
       </Literal>
     </Declarations>
   </Snippet>
   

   Observe que el reemplazo literal obtiene un identificador, Number. Para hacer referencia a ese identificador en el fragmento de código, debe rodearlo con $ caracteres, como se indica a continuación:

   <![CDATA[double root = Math.Sqrt($Number$);]]>
   

2. Guarde el archivo de fragmento de código.

3. Abra un proyecto e inserte el fragmento de código.

   El fragmento de código se inserta y el literal editable está resaltado para su reemplazo. Mantenga el puntero sobre el parámetro de reemplazo para ver la información sobre herramientas del valor.

   

   Sugerencia

   Si hay más de un parámetro reemplazable en un fragmento de código, puede presionar Tab para navegar de un parámetro al otro para cambiar los valores.

Importar un espacio de nombres

Puede usar un fragmento de código para agregar una directiva (C#) o Imports instrucción using (Visual Basic) mediante la inclusión del elemento Imports. Para los proyectos de .NET Framework, también puede agregar una referencia al proyecto mediante el elemento References.

El siguiente XML muestra un fragmento de código que usa el método File.Exists en el System.IO espacio de nombres y, por tanto, define el Imports elemento para importar el System.IO espacio de nombres.

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>File Exists</Title>
      <Shortcut>exists</Shortcut>
    </Header>
    <Snippet>
      <Code Language="CSharp">
        <![CDATA[var exists = File.Exists("C:\\Temp\\Notes.txt");]]>
      </Code>
      <Imports>
        <Import>
          <Namespace>System.IO</Namespace>
        </Import>
      </Imports>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

Contenido relacionado

• Para ver la referencia del esquema XML de fragmento de código de IntelliSense de Visual Studio, consulte Referencia de esquema de fragmentos de código.
• Para crear fragmentos de código en Visual Studio Code, consulte Creación de sus propios fragmentos de código.