LuaLS / LuaLS/lua-language-server

怎么使用luals的文档导出功能

未关闭
#2,927 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 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
./lua-language-server.exe --doc="D:/lua/teast1/test.lua" --doc_out_path="D:/lua/teast1"
```
导出一个lua 文件的代码文档,但是,导出的确实是关于标准库 的代码文档

### Actual Behaviour

导出了标准库的代码文档,例如:
![图片](https://github.com/user-attachments/assets/b675f712-dba2-4bc0-8adf-0ec2432154c1)

### Reproduction steps

1. 新建文件夹和一个示例代码文件:
``` lua
---@meta

---相加
---@param a integer
---@param b integer
---@return integer
function add(a, b) end
```
2. 调用命令:
```
./lua-language-server.exe --doc="D:/lua/teast1/test.lua" --doc_out_path="D:/lua/teast1"
```
3. 输出:

```
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

导出的两个文件
[doc.md](https://github.com/user-attachments/files/17606039/doc.md)
[doc.json](https://github.com/user-attachments/files/17606040/doc.json)

### Log File

文件日志:
[file_d%3A_lua_teast1_test.lua.log](https://github.com/user-attachments/files/17606043/file_d.3A_lua_teast1_test.lua.log)

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 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

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。