LuaLS / LuaLS/lua-language-server
Be confused to Backticks
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ả
Issue Description
I noticed two examples about backticks.
The first is in @generic Capture with Backticks
---@class Vehicle
local Vehicle = {}
function Vehicle:drive() end
---@generic T
---@param class `T` # the type is captured using `T`
---@return T # generic type is returned
local function new(class) end
-- obj: Vehicle
local obj = new("Vehicle")
The second is in @param Generic Function Parameter
---@class Box
---@generic T
---@param objectID integer The ID of the object to set the type of
---@param type `T` The type of object to set
---@return `T` object The object as a Lua object
local function setObjectType(objectID, type) end
--> boxObject: Box
local boxObject = setObjectType(1, "Box")
Are there any differences between them?
---@return T
---@return `T`
Additional Notes
BTW, how can I annotate this:
---@class X
---@field A integer
---@field B string
---@field C boolean[]
---@param x X
---@param key string
---@return ?
function getter(x, key)
return x[key]
end
Is it possible to use backticks?
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
Issue không nêu tên các tệp trong repository, các bài kiểm thử hoặc các entry point. Hãy bắt đầu bằng cách so sánh hai ví dụ được ghi trong tài liệu bằng backtick và chú thích getter, sau đó xác định liệu tài liệu có định nghĩa rõ ý nghĩa của chúng và chú thích được mong đợi cho việc truy cập trường động hay không; được xem là hoàn tất khi các khác biệt và cú pháp được hỗ trợ đã được ghi lại trong tài liệu hoặc issue được giải quyết bằng một thay đổi cụ thể trong tài liệu.
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
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- 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
- 35/100