LuaLS / LuaLS/lua-language-server
怎么使用luals的文档导出功能
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Lua
- Estrellas
- 4.4k
- Forks
- 442
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
### 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
导出了标准库的代码文档,例如:

### 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)
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza ejecutando el comando lua-language-server.exe indicado contra el ejemplo test.lua proporcionado en Windows y, después, compara doc.md y doc.json con el registro adjunto. Se considera terminado cuando la documentación exportada contiene la función add de test.lua, en lugar de incluir únicamente entradas de la biblioteca estándar.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua
- Área
- cli, devtools
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100