LuaLS / LuaLS/lua-language-server
怎么使用luals的文档导出功能
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- Lua
- Étoiles
- 4.4k
- Forks
- 442
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par exécuter sous Windows la commande lua-language-server.exe signalée avec l’exemple test.lua fourni, puis comparez doc.md et doc.json avec le journal joint. C’est terminé lorsque la documentation exportée contient la fonction add de test.lua, et pas seulement des entrées de la bibliothèque standard.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- lua
- Domaine
- cli, devtools
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100