Inline annotations

[muppet9010]

I am looking at trying to add annotations to Lua code snippets that will be parsed by an external tool and run as a single line. This means that I can't use -- and instead have to use --[[ ]] for comments.

My thought of the only way I can do it is to define the classes in another TypeDef only file and then just use --[[@as]] to apply these within my code. The TypeDef file wouldn't be passed to the execution process, only the actual Lua code.

As an example of other limitations I work around I have to end every line with ; as all line breaks are stripped from the Lua code during its parsing by this external tool. I could also end with a space character, but ; is clearer to edit.

[muppet9010]

Its a bit clunky, but better than nothing :)

[sewbacca]

I'm not sure what you are trying to accomplish, but would this do the trick?

Note though, that there is a limit on how long lines can be.

[muppet9010]

thanks that's useful to know.

The main issue I hit was trying to type define a function:

local myFunc = function(data)
end

The best I could think of was:

local myFunc = function(data)
    data = data --[[@as MyClass]] 
end

With MyClass defined in another Lua file. This defining in another file was fine as I don't copy this code in when I execute it and the --[[@as]] in my real code is just ignored when executed.

[sewbacca]

I just tested this and was surprised that it does work:

[muppet9010]

Yes that works better than my attempt for function variable parameter typing variable = variable --[[@as Blah]], thanks :)