How to define parameters for instantiating a class with annotations?

[gagehenderson]

Last month I started heavily using the annotations feature and it's been extremely helpful for me as my codebase gets larger and larger for my project.

However, I am using some OOP throughout my project and I haven't figured out how to define what parameters need to be passed to classes when creating instances of them.

Quick example:

---@param param1 string
---@param param2 string
function MyClass:new(param1,param2)
    ...
end

This doesn't seem to actually provide any context when instantiating my class somewhere else. I was wondering if there's currently any way to do this - Or even if there's a workaround to enable this, I'm willing to refactor some stuff just to make this work.

Also, in practice I tend to actually use the __call metamethod rather than calling any sort of :new or :init method.

I apologize if this is a question that has already been answered, this seems like something a lot of people would run into but I haven't found any exact answers.

[carsakiller]

You can document a __call metamethod using @overload:

---@class myClass
---@overload fun(name: string): myClass
local myClass = {}

---@param name string
function myClass.new(name)
    --...
end