JSDoc generation - generate @returns when function returns a value

[mjbvz]

From @egamma on February 22, 2017 11:14

In the following generated JS Doc comment I would have expected that there is also a @returns comment.

/**
 * 
 * @param {any} a
 * @param {any} b
 */
function foo(a, b) {
  return 12;
}

Copied from original issue: microsoft/vscode#21109

[dtromans]

This was actually supported at one point and disappeared after an update earlier this year. :(

[David-Else]

I would also like to see a @returns!

[PhoneixS]

@mhegazy what feedback are you expecting?

This is something it should do the same way it does with @param. I think there is no need for the tag "Awaiting More Feedback".

The actual issue tracking this is microsoft/vscode#21832

[mhegazy]

what feedback are you expecting?

users saying they want to see this implemented. we did not add it to allow return type to be inferred from parameters. this makes updating the function simpler, since updating the function implementation will take effect instead of having to also update the return type.

[Kamadake]

recently just had a discussion about this with a colleague of mine where he noticed @returns wasn't being outputted automatically when he types /** inside his .ts files.

this should be adjustable in the setting.json. If a user wants it or it's mandatory for a project, let it be configureable by the editor if said team works with VSCode.

[mpf82]

Any progress on this issues?