LuaLS / LuaLS/lua-language-server
怎么使用luals的文档导出功能
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lua
- Sterne
- 4.4k
- Forks
- 442
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Führen Sie zunächst den gemeldeten lua-language-server.exe-Befehl unter Windows mit dem bereitgestellten test.lua-Beispiel aus und vergleichen Sie anschließend doc.md und doc.json mit dem angehängten Log. Als erledigt gilt die Aufgabe, wenn die exportierte Dokumentation die Funktion add aus test.lua und nicht nur Einträge der Standardbibliothek enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- cli, devtools
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100