@param parameter type annotation

Note

Use @param to specify the types of function parameters, to improve completions and other functionality.

• Full format:

---@param param_name MY_TYPE[|other_type] [@comment]

• Target:

  • function parameters

  ---@param car Car
  local function setCar(car)
      ...
  end
  

  ---@param car Car
  setCallback(function(car)
      ...
  end)
  

  • for loop variables

  ---@param car Car
  for k, car in ipairs(list) do
  end