diff options
author | 最萌小汐 <sumneko@hotmail.com> | 2022-06-08 21:25:26 +0800 |
---|---|---|
committer | 最萌小汐 <sumneko@hotmail.com> | 2022-06-08 21:25:26 +0800 |
commit | 38484bc7546869604751274f21de9f46ca8faf9a (patch) | |
tree | 9a2ed7ed41fba94c75930ace95057c512366c855 /doc/zh-tw | |
parent | 48a289b942376118bca24c3766ae1bead1797efc (diff) | |
download | lua-language-server-38484bc7546869604751274f21de9f46ca8faf9a.zip |
config doc
Diffstat (limited to 'doc/zh-tw')
-rw-r--r-- | doc/zh-tw/config/config.md | 493 |
1 files changed, 493 insertions, 0 deletions
diff --git a/doc/zh-tw/config/config.md b/doc/zh-tw/config/config.md new file mode 100644 index 00000000..e0496b43 --- /dev/null +++ b/doc/zh-tw/config/config.md @@ -0,0 +1,493 @@ +# completion.autoRequire + +輸入內容看起來是個檔名時,自動 `require` 此檔案。 + +## default +`true` + +# completion.callSnippet + +顯示函式呼叫片段。 + +## default +`"Disable"` +## enum +* `"Disable"`: 只顯示 `函式名`。 +* `"Both"`: 顯示 `函式名` 與 `呼叫片段`。 +* `"Replace"`: 只顯示 `呼叫片段`。 + +# completion.displayContext + +預覽建議的相關程式碼片段,可能可以幫助你瞭解這項建議的用法。設定的數字表示程式碼片段的擷取行數,設定為 `0` 可以停用此功能。 + +## default +`0` + +# completion.enable + +啟用自動完成。 + +## default +`true` + +# completion.keywordSnippet + +顯示關鍵字語法片段。 + +## default +`"Replace"` +## enum +* `"Disable"`: 只顯示 `關鍵字`。 +* `"Both"`: 顯示 `關鍵字` 與 `語法片段`。 +* `"Replace"`: 只顯示 `語法片段`。 + +# completion.postfix + +用於觸發後綴建議的符號。 + +## default +`"@"` + +# completion.requireSeparator + +`require` 時使用的分隔符。 + +## default +`"."` + +# completion.showParams + +在建議列表中顯示函式的參數資訊,函式擁有多個定義時會分開顯示。 + +## default +`true` + +# completion.showWord + +在建議中顯示上下文單詞。 + +## default +`"Fallback"` +## enum +* `"Enable"`: 總是在建議中顯示上下文單詞。 +* `"Fallback"`: 無法根據語義提供建議時才顯示上下文單詞。 +* `"Disable"`: 不顯示上下文單詞。 + +# completion.workspaceWord + +顯示的上下文單詞是否包含工作區中其他檔案的內容。 + +## default +`true` + +# diagnostics.disable + +停用的診斷(使用浮框括號內的程式碼)。 + +## default +`{}` + +# diagnostics.disableScheme + +不診斷使用以下 scheme 的lua檔案。 + +## default +`{ "git" }` + +# diagnostics.enable + +啟用診斷。 + +## default +`true` + +# diagnostics.globals + +已定義的全域變數。 + +## default +`{}` + +# diagnostics.ignoredFiles + +如何診斷被忽略的檔案。 + +## default +`"Opened"` +## enum +* `"Enable"`: 總是診斷這些檔案。 +* `"Opened"`: 只有打開這些檔案時才會診斷。 +* `"Disable"`: 不診斷這些檔案。 + +# diagnostics.libraryFiles + +如何診斷透過 `Lua.workspace.library` 載入的檔案。 + +## default +`"Opened"` +## enum +* `"Enable"`: 總是診斷這些檔案。 +* `"Opened"`: 只有打開這些檔案時才會診斷。 +* `"Disable"`: 不診斷這些檔案。 + +# diagnostics.neededFileStatus + +* Opened: 只診斷打開的檔案 +* Any: 診斷任何檔案 +* Disable: 停用此診斷 + + + +# diagnostics.severity + +修改診斷等級。 + + +# diagnostics.workspaceDelay + +進行工作區診斷的延遲(毫秒)。當你啟動工作區,或編輯了任意檔案後,將會在背景對整個工作區進行重新診斷。設定為負數可以停用工作區診斷。 + +## default +`3000` + +# diagnostics.workspaceRate + +工作區診斷的執行速率(百分比)。降低該值會減少CPU佔用,但是也會降低工作區診斷的速度。你目前正在編輯的檔案的診斷總是全速完成,不受該選項影響。 + +## default +`100` + +# format.defaultConfig + +**Missing description!!** +## default +`{}` + +# format.enable + +啟用程式碼格式化程式。 + +## default +`true` + +# hint.arrayIndex + +在建構表時提示陣列索引。 + +## default +`"Auto"` +## enum +* `"Enable"`: 所有的表中都提示陣列索引。 +* `"Auto"`: 只有表大於3項,或者表是混合型別時才進行提示。 +* `"Disable"`: 停用陣列索引提示。 + +# hint.await + +**Missing description!!** +## default +`true` + +# hint.enable + +啟用內嵌提示。 + + +# hint.paramName + +在函式呼叫處提示參數名。 + +## default +`"All"` +## enum +* `"All"`: 所有型別的參數均進行提示。 +* `"Literal"`: 只有字面常數型別的參數進行提示。 +* `"Disable"`: 停用參數提示。 + +# hint.paramType + +在函式的參數位置提示型別。 + +## default +`true` + +# hint.setType + +在賦值操作位置提示型別。 + + +# hover.enable + +啟用懸浮提示。 + +## default +`true` + +# hover.enumsLimit + +當值對應多個型別時,限制型別的顯示數量。 + +## default +`5` + +# hover.expandAlias + +**Missing description!!** +## default +`true` + +# hover.previewFields + +懸浮提示檢視表時,限制表內欄位的最大預覽數量。 + +## default +`20` + +# hover.viewNumber + +懸浮提示檢視數字內容(僅當字面常數不是十進制時)。 + +## default +`true` + +# hover.viewString + +懸浮提示檢視字串內容(僅當字面常數包含跳脫字元時)。 + +## default +`true` + +# hover.viewStringMax + +懸浮提示檢視字串內容時的最大長度。 + +## default +`1000` + +# misc.parameters + +VSCode中啟動語言服務時的[命令列參數](https://github.com/sumneko/lua-language-server/wiki/Command-line)。 + +## default +`{}` + +# runtime.builtin + +調整內建庫的啟用狀態,你可以根據實際執行環境停用不存在的庫(或重新定義)。 + +* `default`: 表示庫會根據執行版本啟用或停用 +* `enable`: 總是啟用 +* `disable`: 總是停用 + + + +# runtime.fileEncoding + +檔案編碼,`ansi` 選項只在 `Windows` 平台下有效。 + +## default +`"utf8"` +## enum +* `"utf8"` +* `"ansi"` +* `"utf16le"` +* `"utf16be"` + +# runtime.meta + +**Missing description!!** +## default +`"${version} ${language} ${encoding}"` + +# runtime.nonstandardSymbol + +支援非標準的符號。請務必確認你的執行環境支援這些符號。 + +## default +`{}` + +# runtime.path + +當使用 `require` 時,如何根據輸入的名字來尋找檔案。 +此選項設定為 `?/init.lua` 意味著當你輸入 `require 'myfile'` 時,會從已載入的檔案中搜尋 `{workspace}/myfile/init.lua`。 +當 `runtime.pathStrict` 設定為 `false` 時,還會嘗試搜尋 `${workspace}/**/myfile/init.lua`。 +如果你想要載入工作區以外的檔案,你需要先設定 `Lua.workspace.library`。 + + +## default +`{ "?.lua", "?/init.lua" }` + +# runtime.pathStrict + +啟用後 `runtime.path` 將只搜尋第一層目錄,見 `runtime.path` 的説明。 + + +# runtime.plugin + +延伸模組路徑,請查閲[文件](https://github.com/sumneko/lua-language-server/wiki/Plugin)瞭解用法。 + +## default +`""` + +# runtime.special + +將自訂全域變數視為一些特殊的內建變數,語言服務將提供特殊的支援。 +下面這個例子表示將 `include` 視為 `require` 。 +```json +"Lua.runtime.special" : { + "include" : "require" +} +``` + + +## default +`{}` + +# runtime.unicodeName + +允許在名字中使用 Unicode 字元。 + + +# runtime.version + +Lua執行版本。 + +## default +`"Lua 5.4"` +## enum +* `"Lua 5.1"` +* `"Lua 5.2"` +* `"Lua 5.3"` +* `"Lua 5.4"` +* `"LuaJIT"` + +# semantic.annotation + +對型別註解進行語義著色。 + +## default +`true` + +# semantic.enable + +啟用語義著色。你可能需要同時將 `editor.semanticHighlighting.enabled` 設定為 `true` 才能生效。 + +## default +`true` + +# semantic.keyword + +對關鍵字/字面常數/運算子進行語義著色。只有當你的編輯器無法進行語法著色時才需要啟用此功能。 + + +# semantic.variable + +對變數/欄位/參數進行語義著色。 + +## default +`true` + +# signatureHelp.enable + +啟用參數提示。 + +## default +`true` + +# spell.dict + +**Missing description!!** +## default +`{}` + +# telemetry.enable + +啟用遙測,透過網路發送你的編輯器資訊與錯誤日誌。在[此處](https://github.com/sumneko/lua-language-server/wiki/%E9%9A%B1%E7%A7%81%E8%81%B2%E6%98%8E)閲讀我們的隱私聲明。 + + +## default +`nil` + +# window.progressBar + +在狀態欄顯示進度條。 + +## default +`true` + +# window.statusBar + +在狀態欄顯示延伸模組狀態。 + +## default +`true` + +# workspace.checkThirdParty + +自動偵測與適應第三方庫,目前支援的庫為: + +* OpenResty +* Cocos4.0 +* LÖVE +* LÖVR +* skynet +* Jass + + +## default +`true` + +# workspace.ignoreDir + +忽略的檔案與目錄(使用 `.gitignore` 語法)。 + +## default +`{ ".vscode" }` + +# workspace.ignoreSubmodules + +忽略子模組。 + +## default +`true` + +# workspace.library + +除了目前工作區以外,還會從哪些目錄中載入檔案。這些目錄中的檔案將被視作外部提供的程式碼庫,部分操作(如重新命名欄位)不會修改這些檔案。 + +## default +`{}` + +# workspace.maxPreload + +最大預載入檔案數。 + +## default +`5000` + +# workspace.preloadFileSize + +預載入時跳過大小大於該值(KB)的檔案。 + +## default +`500` + +# workspace.supportScheme + +為以下 `scheme` 的lua檔案提供語言服務。 + +## default +`{ "file", "untitled", "git" }` + +# workspace.useGitIgnore + +忽略 `.gitignore` 中列舉的檔案。 + +## default +`true` + +# workspace.userThirdParty + +在這裡添加私有的第三方庫適應檔案路徑,請參考內建的[組態檔案路徑](https://github.com/sumneko/lua-language-server/tree/master/meta/3rd) + +## default +`{}`
\ No newline at end of file |