自訂代碼 Snippet

有些指令碼需要比 Studio 動作本身更複雜的動作。 Studio 允許您在您的指令碼中新增自訂代碼。 這使您可以自訂指令碼，以滿足貴組織需求。

自訂編碼需要一些指令碼或程式設計知識。 Studio 使用一種稱為 Snippet 的自訂程式設計語言，為在 Studio 中使用而開發。 線上說明中提供了完整的技術參考指南，以讓您能學會使用這種語言。

有關 Snippet 的重要資訊

• Snippet 可以幫助提高指令碼的組織和效率。 這些代碼片段增加了您對執行的進程，以及代碼片段何時和如何執行的控制。 您可以建立自己的變數和物件，並使用 IF、FOR、FOREACH 等語句新增程式設計邏輯。
• 有些產品和功能需要 snippet，但即使不需要，您也可以在您的的指令碼中使用這些 snippet。
• 當一個產品或功能需要 snippet 時，線上說明提供了有關您需要包含的 snippet 的詳細資訊。 提供了一些指令碼範例，以說明如何在指令碼中使用 snippet。 可能需要額外的指令碼來實現產品或功能。
• Snippet 指令碼語言建立在 .NET 框架之上。 該語言在伺服器端執行並編譯為 MSIL（Microsoft 中間語言），就像 C# 和 Visual Basic .NET 一樣。

Snippet 動作

要在您的指令碼中新增自訂代碼，需要 Snippet 動作。 您可以點擊兩下此動作，打開編輯器視窗，您可以在其中新增自訂代碼。 您也可以在編輯器視窗中對代碼進行偵錯。 您的指令碼中可能需要多個 Snippet 動作。 如果您使用多個動作，請使用有助於識別的一個短語來更新每個動作的 Caption 欄位。

Snippet 動作的位置至關重要。 如果 Snippet 為變數賦值，必須放在需要該值的動作之前。 另一方面，如果 Snippet 包含基於獲得傳遞的值而執行動作的決策代碼，則 Snippet 必須放在提供該值的動作之後。

與行動相比的 Snippet

您在 Snippet 中可以做的一些事情也可以用 Studio 動作來完成。 例如，IF 和 FOR 語句的動作。 還有 ASSIGN 動作，您可以使用該動作來建立自訂變數並為其賦值。 使用這些動作是一種將這些能力新增到指令碼中的可接受方式。 然而，使用 Snippet 的效率更高。

透過將代碼放在 Snippet 中，您的指令碼會更乾淨，更有條理，也更容易瀏覽。 這使您更容易、更有效率地完成指令碼編寫員的工作。 如果您養成習慣，總是在 Snippet 中聲明變數，那麼在將來，如果您需要找到某個特定的聲明，您僅需尋找更少的地方。

在指令碼中新增自訂代碼

Snippet 動作允許您向指令碼新增自訂代碼。 此動作位於「工具」標籤上預設調色板的「進階」部分。

1. 在 Studio 中，打開指令碼。
2. 在指令碼中需要代碼的地方放置 Snippet 動作，並將其與其他動作連接起來。
3. 點擊兩下動作，打開編輯器視窗。 這是您可以新增代碼的地方。

4. 點擊您想用來新增代碼的標籤。 每個標籤都提供了不同的新增代碼的方法。 這些標籤是：

   • 樹狀視圖：允許您使用應用程式中提供的清單中的命令建立自訂代碼。 您可以選擇命令並提供必要的詳細資料來配置。

     查看 Snippet 編輯器視窗中「樹狀視圖」標籤的圖像

     

   • 文字視圖：允許您手動輸入自訂代碼。 此選項需要熟練掌握基本指令碼編寫。

     查看 Snippet 編輯器視窗中「文字視圖」標籤的圖像

     

5. 如果需要，請對代碼進行偵錯。

6. 隨時點擊 Apply 來儲存您的變更，而不關閉編輯器視窗。
7. 完成代碼編輯後，點擊 OK。

使用文字檢視進行程式碼

程式碼片段視窗中的「文字檢視」標籤可讓您手寫Snippet程式碼。 線上說明中提供了完整的參考指南，以讓您能學會使用這種語言。

1. 在 Studio 中，打開指令碼。
2. 將Snippet動作新增至指令碼中，然後按兩下以開啟程式碼片段視窗。
3. 在「樹狀視圖」標籤的左側，輸入您的代碼。 您可以輸入代碼，或者從其他來源複製和貼上，例如此說明網站或其他指令碼。
4. 隨時點擊 Tree View 標籤，從預先定義的關鍵字新增代碼。 您可以使用向上和向下的箭頭按鈕，將與某個關鍵字相關的代碼移動到指令碼中的不同位置。
5. 點擊 Check Syntax 圖示 來驗證您當前代碼的語法是否正確。 如果沒有錯誤，「文字視圖」底部工具欄中的狀態列會顯示 Okay 狀態。 如果有錯誤，會顯示關於錯誤的彈出訊息，工具欄上的狀態列會顯示訊息。 例如，訊息可能是 Error at line 4。
6. 點擊 Comment 圖示 將游標當前所在的行轉換成備註。
7. 點擊 Uncomment 圖示 刪除當前游標所在行的備註字元。
8. 隨時點擊 Apply 來儲存您的變更，而不關閉編輯器視窗。
9. 完成代碼編輯後，點擊 OK。

帶有樹狀視圖的代碼

「Snippet 屬性」視窗中的「樹狀視圖」標籤會引導您完成建立自訂代碼的過程。 有一組預先定義的關鍵字供您選擇。

1. 在 Studio 中，打開指令碼。
2. 將 Snippet 動作新增到指令碼中，並點擊兩下來打開 Snippet 視窗。
3. 點擊「樹狀視圖」標籤底部的加號圖示 。
4. 查看圖像

   

   選擇您想新增到代碼中的關鍵字。
5. 點擊視窗左側清單中顯示的關鍵字可查看其屬性。

6. 在視窗右側的清單中配置關鍵字的屬性。 您可以：

   • 選擇每個屬性，在右側窗格下面的空間查看該屬性的定義。
   • 請參閱本頁的 Snippet 關鍵字部分來了解配置每個命令的詳細資料。
7. 根據需要，新增更多的關鍵字。
8. 隨時點擊 Text View 標籤，以查看以傳統編碼格式寫出的代碼。
9. 隨時點擊 Apply 來儲存您的變更，而不關閉編輯器視窗。
10. 完成代碼編輯後，點擊 OK。

Snippet 程式碼偵錯

Snippet 動作有自己的偵錯程式，您可以用其來檢查代碼。 您只能從「文字視圖」標籤中對代碼進行偵錯。

如果您在「樹形視圖」標籤上建立了代碼，當您切換到「文字視圖」標籤時，即可使用偵錯程式。 如果偵錯程式發現任何問題，使用指定的行號來確定代碼的哪一部分包含此問題。 然後，您可以返回到「樹狀視圖」標籤來糾正此問題。

可使用更多的偵錯選項，包括逐步執行代碼逐行偵錯和使用中斷點。 您還可以使用 Snippet 程式碼中的 TRACE 語句，在偵錯期間輸出文字。 在解決指令碼中的問題時，此輸出可能有用。

1. 在 Studio 中，開啟一個包含 Snippet 動作的指令碼。
2. 點擊兩下 Snippet 動作。
3. 如果沒有，請在 Text View 標籤上新增 Snippet 代碼。
4. 在 Snippet editor 視窗的右側，點擊 Debugger 標籤。
5. 點擊 Debug 圖示右側的向下箭頭按鈕並選擇 Start。

6. 如果代碼中存在任何語法錯誤，Snippet editor 視窗會展開。 代碼中的所有錯誤會出現在視窗底部的窗格中。 如果沒有錯誤，則跳到下一個步驟。

   檢視圖像

   
   1. 糾正錯誤。
   2. 糾正錯誤後，點擊 Close 或 Clear Trace Output 圖示 來關閉錯誤窗格。
   3. 再次啟動偵錯程式。
7. 檢視 Variables as Text 標籤的內容。 如果您設定了中斷點，當所有代碼均已執行時，該標籤會顯示變數及其數值。
8. 您可以選擇 snippet 代碼中的一行或多行，然後點擊 Comment out selected lines 圖示 。 如果您想刪除一些代碼以查看偵錯結果如何變化，這很有幫助。
9. 您可以選擇一行或多行的評論代碼，然後點擊 Uncomment the selected lines 圖示 將這些行重新新增到 snippet 中。