函數說明
函數說明分頁自 3.0 版起即已提供;Ninox 編輯器中的語法說明泡泡則自 3.1 版起提供。自 3.2.0 版(測試版)起,說明泡泡會在自動完成清單出現時讓位。
函數說明分頁說明您可以在公式中撰寫的內容:Ninox 的函式、Ninext 所新增的函式,以及您自己資料庫的全域函式。在 Ninox 的腳本編輯器中,語法說明泡泡會在您撰寫的位置直接提供重點說明。
此分頁僅供管理員使用。它只顯示其圖示——一卷羊皮紙——位於架構概覽分頁之後;滑鼠停在上面時會顯示其名稱。此分頁與說明泡泡可在 Ninext 設定的「其他工具」區段中停用:互動式說明。

選擇函式
分頁頂端的選擇器有兩個區域,與欄位與公式中的相同:左側為類別,右側為函式。在右側區域輸入幾個字母:清單只會保留包含這些字母的函式。每個函式前面都有其回傳值型別的圖示。
清單匯集了三個來源:
| 類別 | 內容 |
|---|---|
| ★ Ninext | Ninext 為語言所新增的內容:callNinoxFunction、原生 JS(#{ … }#)、徽章、檢視欄位與按鈕的事件、onNinextLoaded、AI 任務。 |
| ★ Global functions | 您資料庫的全域函式,讀取自其全域程式碼。 |
| Ninox 的類別(Aggregation、Date、Text……) | Ninox 的函式,以及其語言的關鍵字(select、let、if……)。 |
兩個標有星號的類別排在最前面,以淡橘色為背景;Ninox 的類別則依字母順序排在其後。Ninext 的函式以 Ninox 的語言說明(若 Ninext 不認得該語言,則以英文說明);Ninox 的函式則以英文說明。
AI 任務的項目(aiTaskStart、aiTaskStatus、aiTaskCancel 與「AI Tasks」)雖然出現在清單中,但目前尚無作用:它們仰賴 ninext.fr 伺服器,而該伺服器尚未開放。
說明頁的內容
- 標題為函式的名稱及其回傳值的型別,接著是其說明。
- 其簽章(「Signatures」):每一種呼叫方式,以及其參數與參數的型別。若是關鍵字或 Ninext 的新增內容,則為其語法(「Syntax」)。
- 範例(「Example」或「Examples」),以與 Ninox 編輯器相同的方式上色。
- 若是全域函式,則為其完整程式碼(「Script」),附有行號,以及位於其前面的註解。
- 一個 📖 Documentation 連結,指向 Ninox 文件或 Ninext 文件中該函式的頁面(全域函式沒有)。
- 指向相關函式的「See Also」連結。經由這類連結跳轉之後,標題左側的 ← 按鈕可回到上一個說明頁。
滑鼠停留時,每個簽章、每個範例與程式碼都會顯示一個複製按鈕。說明頁的標題(「Signatures」、「Syntax」、「Examples」、「Script」、「See Also」)無論使用哪種語言,都維持英文。
互動式說明開關
在選擇器下方右側,互動式說明開關可開啟或關閉 Ninox 編輯器中的語法說明泡泡。它預設為開啟。其狀態由您的瀏覽器記住:它適用於在此瀏覽器中開啟的所有資料庫,且僅限於此瀏覽器。
請勿將它與 Ninext 設定中同名的設定混淆:該設定關閉時,會為資料庫的所有管理員移除此分頁與說明泡泡。
語法說明泡泡
在 Ninox 的腳本編輯器中,將游標放在某個函式的名稱上——Ninox 的函式、Ninext 的函式,或資料庫的全域函式——或放在某個關鍵字上:游標下方就會開啟一個說明泡泡。它會提供簽章、說明與一個範例。游標離開名稱時,說明泡泡就會關閉。
- 當函式有多個簽章時,可用 ‹ 與 › 箭頭,或箭頭之間的圓點,在各簽章之間切換。
- 說明泡泡右上角那個羊皮紙形狀的按鈕,會在函數說明分頁中顯示該函式的完整說明頁,並關閉說明泡泡。
- 只要 Ninox 的自動完成清單仍開著,或正在選取文字,說明泡泡就會隱藏起來。
在控制台中,當游標位於名稱內部時,也會開啟同樣的說明泡泡;它還會提供關於區域變數、上下文表格的欄位以及關鍵字的資訊。此外,在您輸入函式的引數時,游標上方還會顯示語法指引,並醒目標示目前的參數;這個指引會一直顯示在自動完成清單旁邊。控制台中的說明泡泡既不受這個開關影響,也不受互動式說明設定影響。
