Snippets de código personalizados

Algunos scripts requieren más complejidad que la que pueden brindar las acciones Studio. Studio le permite agregar código personalizado a sus scripts. Esto le permite personalizar sus scripts para satisfacer las necesidades de su organización.

La codificación personalizada requiere algunos conocimientos de scripts o programación. Studio utiliza un lenguaje de programación personalizado llamado Snippet, desarrollado para su uso en Studio. Se encuentra disponible una guía de referencia técnica completa en la ayuda en línea para que pueda aprender a utilizar este lenguaje.

Datos clave sobre los snippets

  • Los snippets de código pueden ayudar a mejorar la organización y la eficiencia de sus scripts. Aumentan su control sobre los procesos que se ejecutan, así como sobre cuándo y cómo se ejecutan. Puede crear sus propias variables y objetos y agregar lógica de programación usando instrucciones como IF, FOR, FOREACH y otras.
  • Algunos productos y funciones requieren snippets, pero puede usarlos en sus scripts incluso cuando no son necesarios.
  • Cuando un producto o función requiere snippets de código, la ayuda en línea proporciona información detallada sobre los snippets que necesita incluir. Se presentan ejemplos de scripts para demostrar cómo usar los snippets de código en los scripts. Es posible que se requieran scripts adicionales para implementar los productos o funciones.
  • El lenguaje de scripts Snippet se basa en el marco .NET. Este lenguaje se ejecuta en el lado del servidor y se compila en MSIL (Lenguaje intermedio de Microsoft) al igual que C# y Visual Basic .NET.

Acción de Snippet

Para agregar código personalizado a sus scripts, necesita una Snippet accion. Puede hacer doble clic en esta acción para abrir una ventana del editor donde puede agregar su código personalizado. También puede depurar el código en la ventana del editor. Puede necesitar más de una acción Snippet en su script. Si usa varias acciones, actualice el campo Caption de cada uno con una frase que ayude a identificar su propósito.

Es importante la colocación de una acción Snippet. Si un Snippet asigna un valor a una variable, debe colocarse antes de la acción que necesita el valor. Por otro lado, si un Snippet contiene un código de toma de decisiones que actúa en función de un valor que se le pasa, debe colocarse el Snippet después de la acción que envía el valor.

Snippets comparados con Acciones

Parte de lo que puede hacer con los snippets también se puede hacer usando las acciones Studio. Por ejemplo, hay acciones para las declaraciones IF y FOR. También existe la acción ASSIGN, que puede usar para crear una variable personalizada y asignarle un valor. El uso de estas acciones es una forma aceptable de agregar estas capacidades a su script. Sin embargo, es más eficiente usar scripts.

Al colocar el código en snippets, su script es más limpio, más organizado y más fácil de navegar. Esto hace que su trabajo como programador sea más fácil y eficiente. Si tiene el hábito de declarar siempre las variables en los snippets, en el futuro, si necesita ubicar una declaración en particular, tendrá menos lugares donde buscar.

Agregar el Código personalizado a un Script

La acción Snippet le permite agregar código personalizado a sus scripts. Esta acción se encuentra en la sección Avanzado de la paleta predeterminada en la pestaña Herramientas.

  1. En Studio, abra un script.
  2. Coloque una acción Snippet en su script donde sea que necesite el código y conéctelo a las demás acciones.
  3. Haga doble clic en la acción para abrir la ventana del editor. Aquí es donde puede agregar su código.

  4. Haga clic en la pestaña que quiera usar para agregar su código. Cada pestaña ofrece un método diferente para agregar código. Las pestañas son:

  5. Depure su código, si así lo desea.

  6. Hacer clic en Apply en cualquier momento para guardar los cambios sin cerrar la ventana del editor.
  7. Hacer clic en OK cuando haya terminado de editar el código.

Código con Text View

La pestaña Text View en la ventana Snippet le permite escribir su Snippet código a mano. Se encuentra disponible una guía de referencia completa en la ayuda en línea para que pueda aprender a usar este lenguaje.

  1. En Studio, abra un script.
  2. Agregue la acción Snippet a su script y haga doble clic en ella para abrir la ventana Snippet.
  3. En el lado izquierdo de la pestaña Vista de árbol, ingrese su código. Puede escribir el código o copiarlo y pegarlo desde otra fuente, como este sitio de ayuda u otro script.
  4. Haga clic en cualquier momento en la pestaña Tree View para agregar código desde las palabras clave predefinidas. Puede usar los botones de flecha hacia arriba y hacia abajo para mover a un lugar diferente en el script el código relacionado con una palabra clave.
  5. Haga clic en el Check Syntax icono El ícono de Comprobar sintaxis, tres pequeños círculos verdes con un triángulo que apunta hacia la derecha. para verificar que sea correcta su sintaxis para el código actual. El campo de estado en la barra de herramientas en la parte inferior de la pestaña Vista de texto muestra el estado Okay si no hay errores. Si hay errores, aparece un mensaje emergente sobre el error y el campo de estado en la barra de herramientas muestra un mensaje. Por ejemplo, el mensaje podría decir Error at line 4.
  6. Haga clic en el Comment ícono El ícono de Comentario, un corchete abierto y un corchete cerrado con una barra inclinada azul entre ellos. para convertir en un comentario la línea donde se ubica actualmente el cursor.
  7. Haga clic en el Uncomment ícono El ícono de Quitar comentario, una gran barra inclinada roja superpuesta sobre un corchete abierto y un corchete cerrado con una barra inclinada entre ellos. para eliminar los caracteres de comentario de la línea donde se encuentra actualmente el cursor.
  8. Hacer clic en Apply en cualquier momento para guardar los cambios sin cerrar la ventana del editor.
  9. Hacer clic en OK cuando haya terminado de editar el código.

Código con la Vista de texto

La pestaña de Vista de árbol en la ventana Propiedades del Snippet lo guía a través del proceso de creación de código personalizado. Está disponible un conjunto predefinido de palabras clave para que usted elija.

  1. En Studio, abra un script.
  2. Añada la acción Snippet a su script y haga doble clic en ella para abrir la ventana Snippet.
  3. Haga clic en el ícono Un signo más con una flecha al lado apuntando hacia abajo. en la parte inferior de la pestaña Vista de árbol.

  4. La ventana del propiedades de Snippets, que muestra la pestaña Vista de árbol. Se presiona el icono de signo más verde y se ve el menú de comandos del Snippet.

    Seleccione la palabra clave que desea agregar a su código.
  5. Haga clic en la palabra clave que aparece en la lista del lado izquierdo de la ventana para ver sus propiedades.

  6. Configure las propiedades de la palabra clave en la lista del lado derecho de la ventana. Ahora es posible:

    • Seleccione cada propiedad para ver una definición de la propiedad en el espacio debajo del panel derecho.
    • Consulte la sección de Palabras clave de los Snippets en esta página para obtener detalles sobre la configuración de cada comando.
  7. Agregue más palabras clave según sea necesario.
  8. Haga clic en la pestaña Text View en cualquier momento para ver el código escrito en formato de codificación tradicional.
  9. Hacer clic en Apply en cualquier momento para guardar los cambios sin cerrar la ventana del editor.
  10. Hacer clic en OK cuando haya terminado de editar el código.

Código de Snippet de Depuración

La acción Snippet tiene su propio depurador que puede usar para verificar el código. Solo puede depurar código desde la pestaña Vista de texto.

Si creó su código en la pestaña Vista de árbol, puede usar el depurador si cambia a la pestaña Vista de texto. Si el depurador encuentra algún problema, use el número de línea especificado para determinar qué parte del código contiene el problema. A continuación, puede volver a la pestaña Vista de árbol para corregir el problema.

Hay más opciones de depuración disponibles, incluyendo recorrer el código línea por línea y usando puntos de interrupción. También puede utilizar TRACE declaraciones en el código de snippets para generar texto durante la depuración. Esta salida puede ser útil para resolver problemas en su script.

  1. En Studio, abra un script que contenga una acción Snippet.
  2. Haga doble clic en la acción Snippet.
  3. Agregue código Snippet en la pestaña Text View , si aún no contiene algunos.
  4. En el lado derecho de la ventana Snippet editor, haga clic en la pestaña Debugger.
  5. Haga clic en el botón de flecha hacia abajo en el lado derecho del Debug icono y seleccione StartUn icono con un triángulo de botón de reproducción verde..

  6. Si hay algún error de sintaxis en el código, se expande la ventana Snippet editor. Todos los errores en el código aparecen en un panel en la parte inferior de la ventana. Si no hay errores, vaya al siguiente paso.

    La ventana del editor de Snippets, que muestra el panel de errores en la parte inferior de la ventana.
    1. Corrija los errores.
    2. Cuando se hayan corregido los errores, haga clic en el Close o los Clear Trace Output iconos para cerrar el panel de errores.
    3. Inicie nuevamente el depurador.
  7. Vea el contenido de la pestaña Variables as Text . La pestaña muestra las variables y sus valores cuando se ha ejecutado todo el código si no definió un punto de interrupción.
  8. Puede seleccionar una o más líneas en el código del snippet y hacer clic en el Comment out selected lines icono . Esto es útil si desea eliminar algún código para ver cómo cambia el resultado de la depuración.
  9. Puede seleccionar una o más líneas de código comentado y hacer clic en el Uncomment the selected lines icono para volver a agregar esas líneas al snippet.