LuaLS / LuaLS/lua-language-server
为函数的参数增加key注释
Đang mở
Chưa có ai nhận issue này.
question
- 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?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Windows
What is the issue affecting?
Other
Expected Behaviour
当一个函数的参数为table时，该怎么为这个参数内的一些key做说明呢，
比如这个例子，直接这样写注释是可以看到，但是看起来乱糟糟的，无法清楚的识别，
有什么办法可以做到类似@alias的格式很方便观看table内每个key都是需要传入什么吗
Actual Behaviour
如上
Reproduction steps
- Go to '...'
- Click '...'
- See error '...'
Additional Notes
No response
Log File
No response
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
Tái hiện yêu cầu trong Visual Studio Code Extension bằng một hàm Lua có tham số bảng với các key được ghi tài liệu. Xem xét hành vi hiện có của LuaLS đối với tham số và chú thích @alias, sau đó xác định cách các chú thích key phải được biểu diễn và hiển thị; hoàn thành có nghĩa là các key có thể được nhận diện rõ ràng trong trình soạn thảo.
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
- devtools
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100