Repository navigation
JSDoc @param does not work for function variables #36633
Description
TypeScript Version: 3.5.1, 3.7.5
Search Terms: jsdoc, param, variable, function
Code
function makeFoo() {
return (x : number) => {}
}
/**
* @param x - Comment
*/
const foo = makeFoo();
foo(/* No comment in hover */);
/**
* @param x - Comment
*/
function foo2(x: number) {
}
foo2(/* Comment in hover */)Expected behavior:
Actual behavior:
Playground Link: Playground
Related Issues: Couldn't find any
For my use case, I use factories to make functions a lot.
export const lPad = makeOperator3<string, bigint, string, string>(/*args*/);
export const rPad = makeOperator3<string, bigint, string, string>(/*args*/);
export const lTrim = makeOperator1<string, string>(/*args*/);
export const rTrim = makeOperator1<string, string>(/*args*/);And I'd like to add JSDoc to these variables, because the parameter names aren't very descriptive, by themselves (left, mid, right, arg, etc.). But it seems like the JSDoc for @param does not show up in hover on VS Code and the Playground.
Activity
AnyhowStep commentedon Feb 5, 2020
Clarification:
There's hover for
foo/foo2. Those come up fine.There's also hover for each parameter. They come up as you fill up the argument list of the function call. The parameter hover is missing the JSDoc.
thanpolas commentedon Mar 5, 2020
I need this too, we use a specific pattern for exporting module where everything is defined under an object that's exported and the JSDoc autocompletes don't work:
A small screencast of the issue: https://d.pr/i/IPpCGR