LuaLS / LuaLS/lua-language-server
怎么使用luals的文档导出功能
オープン
まだ誰も着手していません。
- 主要言語
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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