A
alexandervrs
Guest
I noticed that there is an effort to have a more rich intellisense in the future and as such GMS2 seems to use a kind of javadoc format, however it uses multiple lines of double slash comments which produces a lot of visual noise in scripts and would not be compatible with document generators/parsers and the like.
Also you seem to use an extra @description tag, usually javadoc just finds the text on top of the header to use as description until a @param or @return.
You also use @returns instead of @return which is the standard.
Finally it'd be nice to allow other tags such as @license and @author
I'd recommend to use actual javadoc header format in order to be more within coding standards, compatible with documentation generators plus look nice and not as busy as the current way does. I attach an example of the current way (top) Vs. the standard way (bottom). Notice how much more readable it looks and less noisy.
And this is how I've also been formatting my scripts for GMS1.x for a while now
Also you seem to use an extra @description tag, usually javadoc just finds the text on top of the header to use as description until a @param or @return.
You also use @returns instead of @return which is the standard.
Finally it'd be nice to allow other tags such as @license and @author
I'd recommend to use actual javadoc header format in order to be more within coding standards, compatible with documentation generators plus look nice and not as busy as the current way does. I attach an example of the current way (top) Vs. the standard way (bottom). Notice how much more readable it looks and less noisy.
And this is how I've also been formatting my scripts for GMS1.x for a while now