@param参数类型标记注解

注解

利用 @param 注解来标记函数定义参数的类型,以增强代码提示以及其它功能

../_images/param1.gif
  • 完整格式:
---@param param_name MY_TYPE[|other_type] [@comment]
  • 应用目标:

    • 函数参数
    1
    2
    3
    4
    ---@param car Car
    local function setCar(car)
        ...
    end
    
    1
    2
    3
    4
    ---@param car Car
    setCallback(function(car)
        ...
    end)
    
    • for循环参数
    1
    2
    3
    ---@param car Car
    for k, car in ipairs(list) do
    end
    
Fork me on GitHub