LuaLS / LuaLS/lua-language-server
怎么使用luals的文档导出功能
未關閉
還沒有人認領這個 Issue。
- 主要語言
- Lua
- 星號
- 4.4k
- 分支
- 442
- PR 合併指標
- 30 天內沒有已合併 PR
描述
How are you using the lua-language-server?
Command Line
Which OS are you using?
Windows
What is the issue affecting?
Other
Expected Behaviour
我想要通过这个命令:
./lua-language-server.exe --doc="D:/lua/teast1/test.lua" --doc_out_path="D:/lua/teast1"
导出一个lua 文件的代码文档,但是,导出的确实是关于标准库 的代码文档
Actual Behaviour
导出了标准库的代码文档,例如:
Reproduction steps
- 新建文件夹和一个示例代码文件:
---@meta
---相加
---@param a integer
---@param b integer
---@return integer
function add(a, b) end
- 调用命令:
./lua-language-server.exe --doc="D:/lua/teast1/test.lua" --doc_out_path="D:/lua/teast1"
- 输出:
root uri = file:///d%3A/lua/teast1/test.lua
Documentation exported:4/204
D:\lua\teast1\doc.json
D:\lua\teast1\doc.md
Additional Notes
Log File
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
首先,在 Windows 上針對提供的 test.lua 範例執行回報的 lua-language-server.exe 命令,然後將 doc.md 和 doc.json 與附加的記錄進行比較。完成的標準是匯出的文件包含 test.lua 中的 add 函式,而不只是標準函式庫項目。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- lua
- 領域
- cli, devtools
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 38/100