@return function return type annotation

Note

Use @return to specify the return type of a function

• Full format:

---@return MY_TYPE[|OTHER_TYPE] [@comment]

• Target:

  • functions

  ---@return Car|Ship
  local function create()
      ...
  end
  
  ---Here car_or_ship doesn't need @type annotation, EmmyLua has already inferred the type via "create" function
  local car_or_ship = create()
  

  ---@return Car
  function factory:create()
      ...
  end