JSDoc render with @param Object properties

[stormwind85]

Does this issue occur when all extensions are disabled?: Yes/No

• VS Code Version:
• OS Version:

Steps to Reproduce:

1. Go to vscode.dev
2. Paste the following block of code

/**
 * @param {Object} options the args object
 * @param {number} options.alpha first number
 * @param {number} options.bravo second number
 * @param {Function} callback the callback function
 * @returns {number}
 */
function addNumbersFromObject(options, callback = null) {
    if (!callback) return options.alpha + options.bravo;
    return callback();
}

3. Hover the name of the function addNumbersFromObject with your mouse and wait until JSDoc render is displayed

Expected:

The render should display the Object properties of options variable like the following image.

Actual:

The render does not display the Object properties of options variable.

Tricky solution:

Just replace the type of options variable in the JSDoc by any or * and it will display the Object properties in the render.

However, it will lose autocompletion inside code function when i'll try the access properties of options variable and I don't want to lose this feature.

In order to have autocompletion, we need to use Object type for options variable in JSDoc like the following image.

Recap:

I wish to have at the same time fully JSDoc and autocompletion on an Object variable where I know some of its properties.

Thanks !

[stormwind85]

Well, well, JSDoc looks better now on VSCode but I forgot another case which is still missing.

To reproduce, you can use the bloc of code of my first comment but adding a new property :

/**
 * @param {Object} options the args object
 * @param {number} options.alpha first number
 * @param {number} options.bravo second number
 * @param {Object} options.charlie sub-object
 * @param {number} options.charlie.count third number
 * @param {Function} callback the callback function
 * @returns {number}
 */
function addNumbersFromObject(options, callback = null) {
    if (!callback) return options.alpha + options.bravo + options.charlie.count;
    return callback();
}

Expected:

The render should display Sub-object properties of options.charlie variable like the following image.

Actual:

The render does not display the Sub-object properties of options.charlie variable. It's rendering only Object properties of first level.

Tricky solution:

As I said before, if you replace the type of options.charlie variable in the JSDoc by any or * , it will display the Sub-object properties in the render.

But if we do that, we will lose the autocompletion feature on options.charlie variable.

New recap:

I wish to have at the same time fully JSDoc rendering and autocompletion on an Object variable AND its Sub-object variables when it's defined in the JSDoc of my function.

Thanks !

[sandersn]

Can you open a new bug that uses your recap as the title?
Then ping me on it and I'll tag it appropriately.

[stormwind85]

Can you open a new bug that uses your recap as the title? Then ping me on it and I'll tag it appropriately.

@sandersn

Here is the new issue.