Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

Kommentare

  • Aktualisiert: 5/10/2019
    • 11.3.x
    • Erkunden
    • Enterprise

Kommentare

Die meisten Bots erfordern Änderungen, nachdem sie in Produktion genommen wurden. Kommentare helfen bei Aktualisierungen und Wartung.

Die meisten Bots erfordern Änderungen, nachdem sie in Produktion genommen wurden. Ja nach Typ und Umfang der Bots können häufige Änderungen erforderlich sein. Ob es sich bei einer Änderung um eine relativ einfache Aufgabe handelt oder ob sie sich zu einem Albtraum entwickelt, hängt von zwei Aspekten ab: wie sauber die Bot-Architektur ist und wie gut der Bot dokumentiert und kommentiert ist.

Gute Kommentare können bei einem Wartungszyklus stundenlange Arbeit sparen. Formulieren Sie alle Kommentare einheitlich, und sorgen Sie dafür, dass sie grammatikalisch korrekt sind und dass die Zeichensetzung stimmt.

Allgemeine Regeln zu Kommentaren

  • Rahmen Sie wichtige Abschnitte mit wiederholten Schrägstrichen, Sternen oder Gleichheitszeichen ein:

    Rahmen Sie wichtige Abschnitte mit Gleichheitszeichen ein

  • Erläutern Sie mit einzeiligen Kommentaren Voraussetzungen, bekannte Probleme und Einblicke in die Logik, oder markieren Sie Automatisierungssegmente:

    Erläutern Sie mit einzeiligen Kommentaren Ihre Voraussetzungen

    Erläutern Sie bekannte Probleme und Einblicke in die Logik.

  • Sorgen Sie dafür, dass die Kommentare aussagekräftig sind:

    Beispiel für einen schlechten Kommentar

    Guter Kommentar

  • Schreiben Sie stets den gleichen Kommentar, wenn Sie fehlerhafte Aufgabenzeilen identifizieren, z. B.: //FIX THIS. Oder entfernen Sie den Abschnitt der Aufgabe bzw. schreiben Sie ihn neu!
  • Schreiben Sie Kommentare mit Schlüsselwörtern, die sie in einer Aufgabenliste verwenden würden, damit die Kommentare gefiltert werden können. Beispiel:
    // TODO: Place database command here
    // UNDONE: Removed keystroke command due to errors here
  • Lassen Sie deaktivierte Aufgabenzeilen niemals in der endgültigen Produktionsversion. Deaktivierte Aufgabenzeilen sollten stets gelöscht werden.
  • Versuchen Sie, sich in Kommentaren auf das Warum und Was eines Befehlsblocks zu konzentrieren, nicht auf das Wie. Versuchen Sie, dem Leser verstehen zu helfen, warum Sie eine bestimmte Lösung oder einen Ansatz gewählt haben und was Sie zu erreichen versuchen. Gegebenenfalls sollten Sie auch erwähnen, dass Sie eine alternative Lösung gewählt haben, weil bei der offensichtlichen Lösung ein Problem aufgetreten ist.
Feedback senden