React组件JSDoc中如何添加'aria-label'这类字符串属性？

你可以直接在现有@param列表中添加针对aria-label的注释，由于属性名包含连字符，JSDoc支持直接通过props.aria-label的形式声明，具体写法如下：

/**
 * Some Component
 * @param {Object} props - 组件的props参数
 * @param {boolean} [props.active=false] - 组件激活状态
 * @param {string} props.text - 组件显示的文本内容
 * @param {string} [props.aria-label] - 用于无障碍访问的ARIA标签，为屏幕阅读器提供组件描述
 * ...
 * @returns {React.ReactElement} Some Component
 */

关键要点： #

• 属性名写法：因为aria-label带有连字符，JSDoc允许直接使用props.aria-label，也可以写成props['aria-label']，两种写法都能被工具正确识别。
• 可选性与默认值：如果aria-label是可选属性，用方括号[]包裹参数部分；如果有默认值，可在方括号内补充=默认值，比如[props.aria-label='默认组件标签']。
• 类型与描述：aria-label的类型通常为string，描述里建议注明其无障碍访问的作用，让其他开发者清楚该属性的用途。

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