如何用JSDoc单行描述React useState状态变量？

如果你想在const [animal, setAnimal] = useState()上方用简洁注释描述animal，同时规范标注类型，直接用以下写法即可：

/** 当前陪伴你的动物 @type {[string, React.Dispatch<React.SetStateAction<string>>]} */
const [animal, setAnimal] = useState();

如果追求更好的可读性，也可以用多行注释形式：

/**
 * 当前陪伴你的动物
 * @type {[string, React.Dispatch<React.SetStateAction<string>>]}
 */
const [animal, setAnimal] = useState();

关键说明： #

• 注释开头直接点明animal的含义，完全对应原拆分写法的注释逻辑；
• @type标注了解构后数组的完整类型：第一个元素是状态值（示例中用string，你可根据实际场景替换为number、自定义类型等），第二个元素是配套的setState函数类型，能让类型检查工具正确识别；
• 无需拆分声明变量，保持React代码的解构写法习惯，同时完成状态的文档描述。

内容的提问来源于stack exchange，提问作者Aximili