vscode-docthis icon indicating copy to clipboard operation
vscode-docthis copied to clipboard

Documenting a destructuring parameter is wrong

Open cl1107 opened this issue 4 years ago • 3 comments

prefer

/**
 * Assign the project to an employee.
 * @param {Object} employee - The employee who is responsible for the project.
 * @param {string} employee.name - The name of the employee.
 * @param {string} employee.department - The employee's department.
 */
Project.prototype.assign = function({ name, department }) {
    // ...
};

but get

/**
 *
 *
 * @param {*} { name, department }
 * @return {*} 
 */
Project.prototype.assign = function({ name, department }) {
    // ...
};

https://jsdoc.app/tags-param.html Documenting a destructuring parameter

cl1107 avatar Sep 16 '20 07:09 cl1107

I came here to report exactly the same. This is a great extension, but this is will make it even better.

danielo515 avatar Nov 28 '20 17:11 danielo515

Nice, accepted suggestion. I will implement this in next week.

oouo-diogo-perdigao avatar Dec 03 '20 17:12 oouo-diogo-perdigao

@oouo-diogo-perdigao any progress?

doggy8088 avatar May 30 '21 03:05 doggy8088