LuaLS / LuaLS/lua-language-server

Alias comments only show for strings and numbers

Đang mở
#2,284 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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ả

(Split from: https://github.com/LuaLS/lua-language-server/issues/2279)

Aliases have a feature where they can be multiline and you can write comments for different available values. However, this only works for string and numbers. For example in this code:

---@class TestClass

---@enum TestEnum
TestEnum = {
	TEST1 = 1,
	TEST2 = 2,
	TEST3 = 3,
}

---@alias TestAlias
---| 'TEST1' # TEST1 comment
---| 'TEST2' # TEST2 comment
---| 'TEST3' # TEST3 comment
---| TestClass # TestClass comment
---| TestEnum # TestEnum comment
---| TestEnum.TEST1 # TestEnum.TEST1 comment
---| 1 # TestNumber Comment

---@param test TestAlias
local function test(test)
end

test()

I get this
Screenshot_1

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Tái hiện báo cáo trong LuaLS bằng ví dụ alias từ issue, sau đó theo dõi cách các chú thích alias được thu thập và hiển thị cho các giá trị string và số. Kiểm tra hành vi tương tự đối với TestClass, TestEnum và TestEnum.TEST1; hoàn tất khi các chú thích xuất hiện cho những giá trị alias đó giống như đối với string và số.

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
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
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.