LuaLS / LuaLS/lua-language-server
怎么使用luals的文档导出功能
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Lua
- Star
- 4.4k
- Fork
- 442
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách chạy lệnh lua-language-server.exe được báo cáo trên Windows với ví dụ test.lua được cung cấp, sau đó so sánh doc.md và doc.json với log đính kèm. Được xem là hoàn tất khi tài liệu được xuất có hàm add từ test.lua thay vì chỉ có các mục của thư viện chuẩn.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- lua
- Lĩnh vực
- cli, devtools
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 38/100