.alter function docstring 命令
適用於： ✅Microsoft網狀架構✅Azure 數據總管
DocString改變現有函式的值。
DocString 是可附加至描述實體之數據表/函式/數據行的免費文字。 此字串會顯示在實體名稱旁的各種UX設定中。
注意
如果函式不存在，則會傳回錯誤。 如需如何建立新函式的詳細資訊，請參閱 .create function。
權限
您必須至少有 函式管理員 許可權才能執行此命令。 建立函式的主體會自動成為函式管理員。
語法
.alterfunction FunctionName docstring 檔
深入瞭解 語法慣例。
參數
| 姓名 | 類型 | 必要 | 描述 |
|---|---|---|---|
| FunctionName | string |
✔️ | 要改變之函式的名稱。 |
| 文件 | string |
✔️ | 函式的新 docstring 值。 |
傳回
| 輸出參數 | 類型 | Description |
|---|---|---|
| 名稱 | string |
函式的名稱 |
| 參數 | string |
函式所需的參數 |
| 本文 | string |
（零或更多） let 語句後面接著叫用函式時評估的有效 CSL 表達式 |
| Folder | string |
用於 UI 函式分類的資料夾。 此參數不會變更叫用函式的方式 |
| DocString | string |
UI 用途的函式描述 |
範例
下列範例會更新 MyFunction1 函式的描述 （docstring）。
.alter function MyFunction1 docstring "Updated docstring"
輸出
| 名稱 | 參數 | 本文 | Folder | DocString |
|---|---|---|---|---|
| MyFunction2 | （myLimit： long） | {StormEvents | take myLimit} | MyFolder | 已更新 docstring |