Single line annotation to define function signature (@signature) about intellij-luanalysis HOT 2 OPEN

This mostly comes down to there being a bit of an issue with the doc annotations playing a dual role:

1. Typing
2. Documentation

Concise fun type definitions don't provide a means to document/describe the parameters. Granted, this is already an issue with the existing @overload syntax.

There's also #2 which is different, but also related to the function typing syntax not being as expressive as it ought to be.

Anyway, this is certainly a valid issue. I'll just have to give some thought as to what's the best way to address all the potential use cases.

from intellij-luanalysis.

So fun type definition can't possibly be used to document/describe the parameters? Or is it not implemented as of now?

While not viable for all complex function where you'd maybe want to use comments per parameter, I do think such notation really lowers the threshold to 'type' everything.

Well, if you ever want to discuss any potential approach I'm always free to think along. I have a codebase 200K+ lines of code of Lua in my game and recently decided to transition to a more typed solution such as your plugin. I might be even able to help implement some of the stuff if I think it will benefit in my own situation.

from intellij-luanalysis.