Manuales de usuario

Esta es la guía de usuario sobre la extensión Automatron de Visual Studio 2019

Instalación

Para incluir la extensión a nuestra instalación de Visual Studio tenemos dos opciones. La mas sencilla sería utilizar el marketplace ofrecido por Microsoft, accediendo a la administración de extensiones de nuestro IDE.Introduciendo "Automatron" en el buscador, aparecerá el plugin en los resultados y bastará con instalarlo desde esa pestaña (para que comience a funcionar tendremos que reiniciar Visual Studio). La otra opción sería usar directamente el instalador .VSIX que genera el proyecto al compilarse. Ejecutando este archivo se iniciará de nuevo el proceso de instalación y se añadirá al IDE en cuanto este se reinicie.

La extensión incluye las siguientes librerias por defecto:

1. EnvDTE
2. Microsoft.VisualStudio.Setup.Configuration.Interop
3. Microsoft.VisualStudio.Shell.15.0
4. Microsoft.VisualStudio.Shell.Framework
5. Microsoft.VisualStudio.Shell.Immutable.10.0
6. System.ComponentModel.Primitives
7. System.Core
8. System.Drawing
9. System
10. System.Text.RegularExpressions
11. System.Windows.Forms

Como utilizar

Ya con la extensión instalada el primer paso sería abrirla, para ello clicaremos en el icono que aparecerá en la pestaña "Extensiones" de Visual Studio.

Cuando se abra Automatron aparecerá la lista de macros en pantalla desde la que podremos eliminar, ejecutar o editar cualquiera de las macros ya guardadas en nuestro sistema. Junto con la extensión se incluyen varias macros de ejemplo para que se puedan utilizar como base en la creación de otra nuevas. Además de la gestión de macros existentes esta ventana nos permitirá crear nuevas macros.

Cuando añadamos una nueva macro, o editemos una existente, se abrirá otra ventana de la extensión. En esta nueva interfaz tendremos un formulario en el que completar los atributos de la macro que queramos guardar. Los botones de la parte inferior nos permitirán cerrar la ventana, compilar y probar el código introducido y por último almacenar la macro junto a toda la información que hayamos escrito.

Los errores que pueda devolver la extensión son autodescriptivos y no presentan códigos numéricos que no pueda entender el usuario.

Macros de ejemplo

Para finalizar el manual de usuario se explicarán las macros de ejemplo que incorpora la extensión.

CambiarNombre

Esta macro sirve para modificar el nombre de un archivo de nuestro proyecto. En ella podemos ver como obtener una instancia de EnvDTE, asociada al proceso de Visual Studio, con la que trabajar mediante código. Además, muestra como recorrer todos los archivos de nuestro proyecto utilizando este objeto.

ContarSuscripciones

Este segundo ejemplo nos muestra como podemos acceder al contenido de un archivo de la solución. La macro se encarga de contar las suscripciones y desuscripciones a eventos de un archivo de código leyendo y recorriendo el fichero.

CambiarVersion

La macro CambiarVersion es similar a la anterior pero esta vez reemplazando parte del contenido del archivo en lugar de solo leerlo. Una aplicación real de esta macro sería modificar la versión especificada en el fichero AssemblyInfo.cs de cada proyecto.

InterfazGrafica

Por último la macro InterfazGrafica enseña al usuario a como incluir una ventana gráfica. De esta forma hemos creado una modificación de la macro CambiarVersión pero que nos permite indicar desde una ventana emergente el valor de la nueva versión que queremos que esté presente en AssemblyInfo.cs.