Lire et examiner la documentation Automation Anywhere

Fermer les contenus

Contenus

Ouvrir les contenus

Commentaires

  • Mis à jour le : 5/10/2019
    • 11.3.x
    • Exploration
    • Enterprise

Commentaires

La plupart des robot :s nécessitent des modifications après leur mise en production. Servez-vous de commentaires pour faciliter les mises à jour et la maintenance.

La plupart des robot :s nécessitent des modifications après leur mise en production. Parfois, les modifications peuvent être fréquentes, en fonction du type et de la portée du robot :. Une modification peut être une tâche relativement simple ou un cauchemar complet. La différence entre les deux est déterminée par deux facteurs : la propreté de l'architecture du robot : et la qualité de la documentation et des commentaires relatifs au robot :.

Des commentaires appropriés peuvent faire gagner des heures au cours d'un cycle de maintenance. Écrivez tous les commentaires dans la même langue, assurez-vous qu'ils sont grammaticalement corrects et qu'ils contiennent les signes de ponctuation appropriés.

Règles générales relatives aux commentaires

  • Encadrez les sections importantes par des barres obliques, des astérisques ou des signes « égal » répétés :

    Encadrez les sections importantes par des signes « égal »

  • Utilisez des commentaires d'une ligne pour expliquer les hypothèses, les problèmes connus et les informations logiques, ou pour marquer des segments d'automatisation :

    Utilisez des commentaires d'une ligne pour expliquer les hypothèses

    Expliquez les problèmes connus et les informations logiques.

  • Donnez du sens aux commentaires :

    Exemple de commentaires incorrects

    Commentaires corrects

  • Utilisez toujours des commentaires lorsque vous identifiez des lignes de tâches incorrectes, sous la forme d'une expression courante telle que //FIX THIS. Sinon, supprimez ou réécrivez cette partie de la tâche.
  • Incluez des commentaires à l'aide des indicateurs de mots-clés de la liste des tâches pour permettre le filtrage des commentaires. Exemple :
    // TODO: Place database command here
    // UNDONE: Removed keystroke command due to errors here
  • Ne laissez jamais des lignes de tâches désactivées dans la version de production finale. Supprimez toujours les lignes de tâches désactivées.
  • Essayez de centrer les commentaires sur l'explication et le contenu d'un bloc de commande et non sur son mode de création. Essayez d'aider le lecteur à comprendre pourquoi vous avez choisi une solution ou une approche spécifique et ce que vous essayez d'obtenir. Le cas échéant, indiquez également que vous avez choisi une autre solution car vous avez rencontré un problème avec la solution évidente.
Envoyer le commentaire