Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

註解

  • 已更新:5/10/2019
    • 11.3.x
    • 探索
    • Enterprise

註解

大多數的機器人在投入生產之後都需要變更。使用註解有助於進行更新和維護。

大多數的機器人在投入生產之後都需要變更。有時候,這些變更可能很頻繁,端視機器人的類型和範圍而定。讓變更成為一項相當簡單直接的作業,還是一場徹底的夢魘,主要是由以下兩個因素來決定:機器人架構的簡潔程度,以及機器人記錄與註解的完善程度。

良好的註解可能會在維護期間產生數小時的作業差異。請用相同的語言撰寫所有註解、確保文法正確並且加上適當的標點符號。

一般註解規則

  • 使用重複的斜線、星號或等號框住重要的區段:

    使用等號框住重要的區段

  • 使用單行註解來說明假設、已知問題和邏輯見解,或標示自動化片段:

    使用單行註解來說明假設

    說明已知問題和邏輯見解。

  • 讓註解具有意義:

    錯誤註解的範例

    正確註解

  • 當您發現錯誤的作業行時,一定要使用一些常用片語 (例如 //FIX THIS) 來加上註解,否則,請移除或重寫該作業部分!
  • 使用作業清單關鍵字旗標加入註解,以便能夠篩選註解。範例:
    // TODO: Place database command here
    // UNDONE: Removed keystroke command due to errors here
  • 絕對不要在最終生產版本中留下已停用的作業行。請務必刪除已停用的作業行。
  • 請盡量將註解的重點放在命令區塊的使用原因和內容,而非使用方式。試著協助讀者了解您選擇特定解決方案或方法的原因,以及您嘗試達成的目標。如果情況適用,請一併提及您之所以選擇替代解決方案是因為在使用顯而易見的解決方案時發生問題。
傳送意見反饋