Declaration-like jsdocs are incorrectly attached to the following statement

[thorn0]

Bug Report

🔎 Search Terms

jsdoc docblock typedef

🕗 Version & Regression Information

• This is the behavior in every version I tried

⏯ Playground Link

playground

💻 Code

/** @typedef {{foo: 'foo'}} Foo */

function f() {
}

f()

🙁 Actual behavior

Whenever JSDoc typedef blocks are followed by a function (or variable) declaration TS attaches that JSDoc to the function and shows typedefs as part of the function's description when its name is hovered.

(The described behavior is old, but the screenshot of v4.3.0-dev is here to show an extra bug with [object Object].)

🙂 Expected behavior

Typedefs shouldn't be attached to subsequent statements.

As @sandersn wrote in #42895 (comment):

Declaration-like jsdocs are incorrectly attached to the following statement. The fix is probably as simple as a filter somewhere -- the compiler itself doesn't care where @typedef is, only the services layer does -- but I'm not sure which component should do the filtering.

[sandersn]

I can't repro the [object Object] bug with the latest dev build.

@thorn0 Do you care about the extraneous @typedef in the quick info for VS Code, or in the services API, or somewhere else?

[thorn0]

v4.3.0-dev.20210413 on the playground shows [object Object] to me.

Do you care about the extraneous @typedef in the quick info for VS Code

In VS Code. Are you considering keeping the comment attached to the statement and only hiding typedef tags from it? Not a bad option, but typedefs can have their own descriptions in the same comment, and these descriptions won't be hidden in that case, right?

BTW, currently the descriptions are concatenated in an interesting way (playground, playground 2):

But it's a separate issue I guess.

[sandersn]

[object Object] is happening because, I'm pretty sure, the language server thinks the playground wants the new displayparts format for comments instead of the old string format. This doesn't happen on my slightly old version of Code or my up-to-date emacs, which I think covers the two main code paths. I'll file a bug to track down whether this is just our use of Monaco or whether it applies to all Code-family editors.

jsdoc is parsed as an optional leading comment (In the above screenshot, "Ipsum") and a sequence of tags with optional trailing comments. So

/** @typedef {number} N Some commentary
  @type {N} More commentary */
var n = 12

would only show the @type tag and "More commentary" after the typedef is filtered out.

[sandersn]

Filed #43672 for the playground [object Object] mis-rendering.

[thorn0]

/**
 * Ipsum
 * @typedef {{foo: 'foo'}} Foo Lorem
 */

function f() {
}

corresponds to the following TS syntax:

/**
 * Ipsum
 * Lorem
 */
type Foo = {foo: 'foo'};

function f() {
}

So I think showing "Ipsum" in the quick info for f most of the times would be surprising,