LuaLS / LuaLS/lua-language-server

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

Aperta
#2,927 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia eseguendo su Windows il comando lua-language-server.exe indicato con l’esempio test.lua fornito, quindi confronta doc.md e doc.json con il log allegato. Il lavoro è completato quando la documentazione esportata contiene la funzione add di test.lua invece delle sole voci della libreria standard.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua
Ambito
cli, devtools
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.