JSDoc @return vs. @returns

[Lukáš Vlček]

Hi,

looking into all code examples on Google [1,2] I can see @return is strictly used instead of @returns which on the other hand seems to be recommended by JSDoc 3 API doc [3].

Is there any disadvantage if I use @returns in Closure code? The point is that IntelliJ IDEA generates JSDoc stubs with @returns by default so I wonder if there is any impact if I forget to change it to @return.

Regards,

Lukas

[1] https://developers.google.com/closure/compiler/docs/js-for-compiler#tag-return

[2] http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml

[3] http://usejsdoc.org/tags-returns.html

[John Lenz]

The two are equivalent as far as I know.

--
 
---
You received this message because you are subscribed to the Google Groups "Closure Library Discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to closure-library-d...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.