Custom comments on a module / object / function (like an info bubble)

Solar2D General Questions/Discussion
#1

Hey all,

So I have no clue what to search for on this one. The idea I am thinking of is having an info bubble come up when I call an object I created. Currently, the object creates a space-ship, and I need to pass it parameters. I have decided to accept a table, so I can pass whatever I need to it, without having to pass something in a specific order. 

Something like:

[lua] ship:new({name=“X”,…})
.

.
function Ship:new(params) [/lua]

I thought it would be cool, if every time I type ship:new(), that a popup would come up with some custom comments, so I could write things like:

Comment: Current variables: Health, Shields… and so on. An example of this is whenever you hover over a corona function in my IDE (ZeroBrane) and it gives you some quick tips.

Does anyone know of any IDE or way to code it so this happens?

Regards,

Skybad

#2

I think some of them do it, better to ask direct. the Ship:new() syntax is standard enough. The fly in the ointment is the actual definition of the class itself, which is done different ways by different OOP methods.

#3

What do you mean by this?

#4

Ask the developers.

#5

I think some of them do it, better to ask direct. the Ship:new() syntax is standard enough. The fly in the ointment is the actual definition of the class itself, which is done different ways by different OOP methods.

#6

What do you mean by this?

#7

Ask the developers.