Force @return or @returns

[gajus]

Have a rule that forces user to use either @return tag or @returns.

[qfox]

Does checkAnnotations: { extra: { "returns": null } } to deny @returns would be fine?

[qfox]

I should say that currently you allowing both when you using closure or jsdoc3 tag set:

jscs-jsdoc/lib/tags/jsdoc3.json

Lines 64 to 65 in 1d6e20f

	"return": true,
	"returns": true,

But I'm not sure that this is right.
Closure compiler uses @return: https://developers.google.com/closure/compiler/docs/js-for-compiler#tag-return — Guess we can safely remove @returns from it.
JSDoc3 http://usejsdoc.org/tags-returns.html — supports both.

Ref: #76

[gajus]

Semantically, @return does not make sense. You don't give a command to the function. You describe what it does. It returns a value.

On Oct 2, 2015, at 22:07, Alexej Yaroshevich [email protected] wrote:

I should say that currently you allowing both when you using closure or jsdoc3 tag set:

jscs-jsdoc/lib/tags/jsdoc3.json

Lines 64 to 65 in 1d6e20f

	"return": true,
	"returns": true,

But I'm not sure that this is right.
Closure compiler uses @return: https://developers.google.com/closure/compiler/docs/js-for-compiler#tag-return — Guess we can safely remove @returns from it.
JSDoc3 http://usejsdoc.org/tags-returns.html — supports both.

Ref: #76

—
Reply to this email directly or view it on GitHub.

[gajus]

Has any decision been taken regarding this since?

[qfox]

I'd suggest to wait "multi-sets" (when you'll be able to use jsdoc3 with googleclosure addon) and then cleanup tag sets (e.g. remove returns from googleclosure set).

I think we shouldn't remove @return from jsdoc3 according to docs: http://usejsdoc.org/tags-returns.html
But there is no @returns in googleclosure: https://developers.google.com/closure/compiler/docs/js-for-compiler ;-)

What you think?

[gajus]

A rather general suggestion is to remove https://github.com/jscs-dev/jscs-jsdoc#checkannotations entirely. This rule is too broad. Instead, allow granular control (allowed, not allowed), case sensitive, control of all the supported tags.