Adding documentation comments to the return values of destructuring syntax

[melxy1997]

Type: Feature Request

• In ReactJS, we often write code similar to const [stateX, setStateX] = useState({ ... });.

• I would like to hover over the variable name stateX with the mouse in other places where this variable is used to get an explanation similar to JSDoc (not for type, but to more clearly annotate the purpose of the variable).

• The reason I think this way is because the following approach often works:

/** It's a ref for X */
const refX = useRef({ ... });

(When I hover over the refX variable in other places where it is accessed, the tooltip can display the documentation "It's a ref for X".)

• However, I have not found any way to annotate without disrupting the original code structure, so that VSCode can recognize my documentary comments for the tuple.
• I'm not sure whether this should be considered a feature request or a bug report.

VS Code version: Code 1.95.3 (Universal) (f1a4fb101478ce6ec82fe9627c43efbf9e98c813, 2024-11-13T14:50:04.152Z)
OS version: Darwin arm64 22.3.0
Modes:

[vs-code-engineering]

Thanks for creating this issue! It looks like you may be using an old version of VS Code, the latest stable release is 1.96.0. Please try upgrading to the latest version and checking whether this issue remains.

Happy Coding!