Compartir a través de

Fragmentos de código y cómo usarlos

Los fragmentos de código son pequeños bloques de código reutilizables que puede agregar a un archivo de código. Los fragmentos de código normalmente contienen bloques de código usados a menudo, como bloques de Try...Finally o bloques de If...Else. También puede usar fragmentos de código para agregar clases o métodos completos.

Un fragmento de código tiene un título que se usa para seleccionar el fragmento de código y puede tener un nombre de acceso directo que puede escribir para insertar el fragmento de código. Los fragmentos de código también pueden contener parámetros de reemplazo, que actúan como marcadores de posición. Los fragmentos de código están disponibles para muchos lenguajes, como C#, C++y Visual Basic.

Fragmentos de código de expansión y fragmentos de código envolventes

Puede agregar dos tipos de fragmentos de código al código:

  • Se agrega un fragmento de código de expansión en un punto de inserción especificado.
  • Se agrega un fragmento de código envolvente alrededor del código seleccionado y solo está disponible para C# y C++.

Búsqueda de fragmentos de código disponibles

Para ver los fragmentos de código disponibles para un idioma, seleccione Herramientas> Administrador de fragmentos de código en la barra demenús, o presione Ctrl+K, B y, a continuación, seleccione el idioma que desee en el menú desplegable.

Captura de pantalla del cuadro de diálogo Administrador de fragmentos de código.

Para crear e importar su propio fragmento de código para que aparezca en la lista de fragmentos de código, vea Tutorial: Creación de un fragmento de código en Visual Studio.

Agregar un fragmento de código a un archivo de código

Para agregar un fragmento de código a un archivo de código:

  1. En el editor de código, coloque el cursor o seleccione Código de C# o C++ donde quiera agregar el fragmento de código.

  2. Realice una de las siguientes acciones:

    • En la barra de menús de Visual Studio, elija Editar>IntelliSense>Insertar fragmento o Editar>IntelliSense>Rodear con.
    • Haga clic con el botón derecho y elija Fragmento>Insertar Fragmento o Fragmento>Envolver Con en el menú contextual.
    • En el teclado, presione Ctrl+K, X para un fragmento de código de expansión o Ctrl+K, S para un fragmento de código envolvente.

  3. Haga doble clic en el fragmento que desee en la lista desplegable, o escriba el acceso directo del fragmento y presione Tab o Intro.

Adición de un fragmento de código de expansión

Por ejemplo, el fragmento de código tryf de expansión de C# agrega el siguiente Try...Finally bloque:

try
{

}
finally
{

}

Para agregar este fragmento de código de expansión:

  1. En el editor de código, coloque el cursor donde desea agregar el fragmento de código.
  2. Haga clic con el botón derecho y seleccione Insertar fragmento de código en el menú contextual, o bien use la barra de menús o los comandos de teclado.
  3. Abra la carpeta Visual C# y, a continuación, haga doble clic en tryf en la lista desplegable, o seleccione tryf y presione Tab o Entrar.

Sugerencia

También puede colocar el cursor en el punto de inserción, escribir tryf y, a continuación, presionar Tab dos veces.

Adición de un fragmento de código envolvente

En el ejemplo siguiente de un fragmento de código de C++, el acceso directo if se puede usar como un fragmento de código de inserción o un fragmento de código envolvente. Si selecciona la línea return FALSE; de código y luego elige Envolver con>si, el fragmento de código se expande alrededor de la línea.

if (true)
{
    return FALSE;
}

Parámetros de reemplazo de fragmentos de código

Los fragmentos de código pueden contener parámetros de reemplazo, que son marcadores de posición que debe reemplazar para ajustarse al código que está escribiendo. En el ejemplo anterior, true es un parámetro de reemplazo, que se reemplaza por la condición adecuada. El reemplazo se repite para cada instancia de ese parámetro de reemplazo en el fragmento de código.

Por ejemplo, Visual Basic tiene un fragmento de código que define una propiedad. Para insertar el fragmento de código:

  1. En el menú contextual al hacer clic con el botón derecho en un archivo de código de Visual Basic, seleccione Fragmento de código>Insertar fragmento.
  2. Seleccione Patrones de código>Propiedades, Procedimientos, Eventos>Defina una propiedad.

Captura de pantalla del menú de fragmento de código para Definir una propiedad.

Se inserta el código siguiente:

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

Si cambia newPropertyValue a m_property, cada instancia de newPropertyValue cambia. Si cambia String a Int en la declaración de propiedad, el valor en el método Set también cambia a Int.

Procedimientos recomendados para usar fragmentos de código

El código de un fragmento de código muestra solo la manera más básica de hacer algo. Para la mayoría de las aplicaciones, el código debe modificarse para adaptarse a la aplicación.

Control de excepciones

Normalmente, los bloques de fragmento Try...Catch de código detectan y lanzan nuevamente todas las excepciones, pero es posible que no sea la opción adecuada para tu proyecto. Para cada excepción, hay varias maneras de responder. Para obtener ejemplos, vea Cómo controlar una excepción mediante try/catch (C#) y Instrucción Try...Catch...Finally (Visual Basic).

Ubicaciones de archivo

Al adaptar ubicaciones de archivos a la aplicación, asegúrese de tener en cuenta los siguientes factores.

  • Busque una ubicación accesible. Es posible que los usuarios no tengan acceso a la carpeta Archivos de programa del equipo, por lo que es posible que el almacenamiento de archivos de usuario con los archivos de aplicación no funcione.

  • Busque una ubicación segura. El almacenamiento de archivos en la carpeta raíz como C:\ no es seguro. Para los datos de la aplicación, es mejor usar la carpeta Datos de aplicación. Para los datos de usuario individuales, la aplicación puede crear un archivo en la carpeta Documentos de cada usuario.

  • Use un nombre de archivo válido. Puede usar los OpenFileDialog controles y SaveFileDialog para reducir la probabilidad de nombres de archivo no válidos.

  • Tenga en cuenta que un archivo seleccionado por el usuario podría eliminarse antes de que el código pueda manipular el archivo. Además, es posible que un usuario no tenga permiso para escribir en el archivo.

Seguridad

La seguridad de un fragmento de código depende de dónde la use en el código fuente y de cómo la modifique una vez que se encuentra en el código. La lista siguiente contiene algunas áreas que se deben tener en cuenta:

  • Acceso a archivos y bases de datos
  • Seguridad de acceso al código
  • Protección de recursos como los registros de eventos y el sistema de registro
  • Almacenamiento de secretos
  • Comprobación de entradas
  • Pasar datos a tecnologías de scripting

Para obtener más información, consulte Aplicaciones seguras.

Fragmentos de código descargados

Los fragmentos de código instalados por Visual Studio no son peligros de seguridad. Sin embargo, pueden crear riesgos de seguridad en la aplicación. Los fragmentos de código descargados de Internet deben tratarse con extrema precaución, como cualquier otro contenido descargado. Descargue fragmentos de código solo de sitios de confianza y use up-tosoftware de virus date.

Abra todos los archivos de fragmento de código descargados en el Bloc de notas o en el editor XML de Visual Studio y revise cuidadosamente antes de instalarlos. Tenga cuidado con los siguientes problemas:

  • Código que podría dañar tu sistema si lo ejecutas. Lea cuidadosamente el código fuente antes de ejecutarlo.

  • HelpURL bloquea los archivos de fragmento de código que contienen direcciones URL que ejecutan archivos de script malintencionados o muestran sitios web ofensivos.

  • Fragmentos de código que contienen referencias que se agregan de forma silenciosa al proyecto y se pueden cargar desde cualquier lugar del sistema. Puede descargar estas referencias desde la misma ubicación desde la que se descarga un fragmento de código. Después, el fragmento de código podría llamar a un método en la referencia que ejecuta código malintencionado. Para detectar estas referencias, revise los bloques Imports y References del archivo de fragmento de código.

Contenido relacionado