• Hey Guest! Ever feel like entering a Game Jam, but the time limit is always too much pressure? We get it... You lead a hectic life and dedicating 3 whole days to make a game just doesn't work for you! So, why not enter the GMC SLOW JAM? Take your time! Kick back and make your game over 4 months! Interested? Then just click here!
  • Hello [name]! Thanks for joining the GMC. Before making any posts in the Tech Support forum, can we suggest you read the forum rules? These are simple guidelines that we ask you to follow so that you can get the best help possible for your issue.

Question - IDE [Suggestion] JSDoc @return

B

Big_Macca_101

Guest
Just a small suggestion that will have a minor impact but when programming scripts with the JSDoc synatx's, why not add an @return syntax to help simplify programming without other people needing to root around code to work out what sort of value is returned.

For example it could be used similar to this..

/// @return {real} (Just show a real being returned)
/// @return {real} Server_ID (A real being returned but also have a brief comment)

This could also be implemented with the default GML functions to remove as much jumping to the documentation just to work out the returned value's type.
 
rwkay

rwkay

GameMaker Staff
GameMaker Dev.
GMS2 already supports this and we have plans to use it more in the future.

Russell
 
B

Big_Macca_101

Guest
Is the syntax /// @return?

I have it in my scripts but it doesn't show any sign of actually being there at all...
 
You must log in or register to reply here.
Top