Lea y revise la documentación de Automation Anywhere

Cerrar contenidos

Contenidos

Abrir contenidos

Comentar

  • Actualizado: 5/10/2019
    • 11.3.x
    • Explorar
    • Enterprise

Comentar

La mayoría de los bots requieren cambios después de colocarse en producción. Use comentarios para ayudar a las actualizaciones y el mantenimiento.

La mayoría de los bots requieren cambios después de colocarse en producción. Ocasionalmente, estos cambios pueden ser frecuentes, según el tipo y el alcance de bot. La diferencia entre que un cambio sea una tarea relativamente simple o una completa pesadilla es determinada por dos cosas: qué tan limpia es la arquitectura de bot y qué tan bien documentados y comentados están los bot.

Buenos comentarios pueden significar una diferencia de horas durante un bucle de mantenimiento. Escribe todos los comentarios del mismo idioma, asegurándose de que sean gramáticamente correctos y que contengan información precisa.

Reglas de comentarios generales

  • Encierre secciones importantes con barras, asteriscos o signos de igual repetidos:

    Encierre secciones importantes con signos de igual

  • Use comentarios de una línea para explicar suposiciones, problemas conocidos e información de lógica o para marcar segmentos de automatización:

    Use comentarios de una línea para explicar suposiciones

    Explique problemas conocidos e información de lógica.

  • Haga que sus comentarios sean significativos:

    Ejemplo de comentarios incorrectos

    Comentarios correctos

  • Siempre use comentarios cuando identifica líneas de tareas incorrectas con alguna frase común, como //FIX THIS, de lo contrario, elimine o vuelva a escribir esa parte de la tarea.
  • Incluye comentarios usando alertas de palabras claves de la Lista de tareas para permitir filtrar los comentarios. Ejemplo:
    // TODO: Place database command here
    // UNDONE: Removed keystroke command due to errors here
  • Nunca deje líneas de tareas deshabilitadas en la versión final de producción. Siempre elimine las líneas de tareas deshabilitadas.
  • Intente enfocar los comentarios en los motivos y las explicaciones de un bloque de comando, no en el modo. Intenta ayudar al lector a comprender por qué eligió una solución o enfoque determinado y qué es lo que está intentando lograr. Si corresponde, también mencione que eligió una solución alternativa porque se encontró con un problema al intentar la solución evidente.
Enviar comentarios