如果属性名称是字符串，如“aria-label”，如何编写 JSDoc

Question

我想为一些 React 组件编写 JSDoc:

/**
 * Some Component
 * @param {Object} props - props of the component
 * @param {boolean} [props.active=false] - active
 * @param {string} props.text - text
 * ...
 * @returns {React.ReactElement} Some Component
 */

如何在 JSDoc 中正确添加名为

'aria-label'

的属性？

我在网上找不到必要的解决方案。

Answer 1

@param {string} props['aria-label'] - your description

或者如果不是 props 对象的一部分：

@param {string} ['aria-label'] - your description