如何使用 JSDoc 来记录样式组件道具？

Question

我曾多次尝试在我的自定义样式组件上使用 JSDoc 在 vscode 上记录道具，但我就是无法以任何方式显示它。

我试过以下语法：

/**
 * @param {boolean} testprop - 20px
 */
export const Text``

export interface TextProps {
  /* 20px */ t2?: boolean
}
export const Text<TextProps>``

None 目前这 2 个有效。

• 有没有办法让它在悬停道具时显示出来？
• 这方面的最佳做法是什么？

Answer 1

这个语法对我有用：

export interface TextProps {
  /** 20px */ t2?: boolean
}
export const Text<TextProps>``

注意评论以 2 个星号开头 (/**)

现在我可以悬停t2并获取我之前设置的评论。