當您撰寫適用於 Orchestrator 外掛程式與相關 API 說明文件的使用者介面 (UI) 字串時,請依照樣式與格式的公認規則。

一般建議

  • 在外掛程式中使用提及的 VMware 產品的正式名稱。例如:使用下列產品的正式名稱及 VMware 詞彙。

    正確術語

    請勿使用

    vCenter Server

    VC 或 vCenter

    vCloud Director

    vCloud

  • 以句點結束所有工作流程的描述。例如:Creates a new Organization. 為工作流程描述。

  • 使用含拼字檢查程式的文字編輯器寫入描述,然後移至外掛程式中。

  • 確保外掛程式的名稱與相關聯並經審核的第三方產品名稱完全相符。

工作流程及動作

  • 寫入資訊性描述。大多數的動作和工作流程只需一或兩句描述即已足夠。

  • 更高階層的工作流程可能包括更廣泛的描述與註解。

  • 請以動詞作為描述的開頭,例如 Creates…。請勿使用如 This workflow creates 等自我參照的語言。

  • 在描述結尾加上句點,完成該句的描述。

  • 描述工作流程或動作的作用,而非執行的方式。

  • 工作流程與動作通常包括在資料夾與套件中。同樣針對這些資料夾與套件包含簡短描述。例如:工作流程資料夾可擁有類似 Set of workflows related to vApp Template management 的描述。

工作流程與動作的參數

  • 例如:用描述性的名詞片語 Name of 作為工作流程與動作描述的開頭。請勿使用如 It's the name of 的片語。

  • 請勿在參數結尾及動作描述後加上句點。這些皆非完整句子。

  • 工作流程的輸入參數必須在呈現視圖中指定含有適當名稱的標籤。在多數情況下,您可在顯示群組中組合相關的輸入。例如:在未輸入兩個含有組織名稱與組織全名標籤的情形下,您可建立含有標籤組織的顯示群組並在組織群組中放上輸入名稱及全名。

  • 在步驟與顯示群組方面,新增描述或註解也會出現在工作流程簡報中。

外掛程式 API

  • API 的說明文件意指 vso.xml 檔案及 Java 來源檔案中的所有說明文件。

  • 如為 vso.xml 檔案,請使用相同規則來描述 finder 物件和指令碼物件,搭配您用於工作流程和動作的方法。物件屬性及方式參數的描述皆使用與工作流程及動作參數相同的規則。

  • 請避免在 vso.xml 檔案中使用特殊字元以及在 <![CDATA[insert your description here!]]> 標籤中加入描述。

  • Java 來源檔案請使用標準 Javadoc 樣式。