Multiline JSDoc Types

[mjbvz]

From microsoft/vscode#27777

Issue
For the javascript:

/**
 * @param {{
 *  z: number
 * }} x
 */
function foo(x){}

The type of x is any. It seems multiline types are not recognized in jsdocs

There seems to be some debate about whether this is supported or not: jscs-dev/node-jscs#245 but it seems closure and some other tools support the multiline syntax

Also tracking syntax highlighting for this case here: microsoft/TypeScript-TmLanguage#467

[seanf]

As a workaround, it may help to delete the leading * characters on the lines in between {{ and }}. Assuming your linter will let you.

[rob2d]

@seanf did not seem to help in my use-cases; would be great if this were built in without needing an explicit linter (since jsdoc technically already accepts multiline params)

[sandersn]

@rob2d can you post an example of the code you couldn't get to work? I tried @mjbvz's example, and after deleting the leading asterisks, the type works:

/**
 * @param {{
   z: number
  }} x
 */
function foo(x){  x.z }

Not skipping leading asterisk is a known bug #23667. You may have found a different bug.

[weswigham]

AFAIK this is fixed now.

[nomaed]

@weswigham is it?

With VSCode Version 1.30.1:

[weswigham]

AFAIK the syntax highlighting is still waiting on atom/language-javascript#515

[nomaed]

Yes, I found this link a bit after asking about it. Thanks!

[RodrigoTomeES]

hi

I found an issue with the multi-line JSDoc but I don't know if this will be here or I need to create another issue because it's related with multi-line JSDoc Types.

The bug is that if you use multi-line the type is not inferred but if I put all in one line the type is inferred.

Screen.Recording.2024-01-08.at.09.17.20.mov

[sandersn]

Please do file a new bug. This one tracked the addition of the feature, not bugs with it.

When you do, can you provide the text of your program or a link to the typescript playground with your program included?