在 TSDoc 中键入 React 道具的正确格式是什么？

Question

我正在尝试将 TSDoc 标准用于评论用 Typescript 编写的 React 项目（着眼于使用 Typedoc 生成文档），但找不到任何明确的答案来注释 React props object 的首选方法。 到目前为止，我已经有了这个，其中MyProps是一个接口：

/**
 * Description of my function component
 * @param props - React props
 */
export default function MyComponent(props: MyProps) { ...

有首选方法吗？

Answer 1

您想要记录道具接口，而不是组件本身。 这意味着这与记录接口的字段相同。

import React from 'react'

interface FooProps {
  /** Testing 123 */
  foo: string
}

function Foo({foo}: FooProps) {
  return <>{foo}</>
}

<Foo foo="bar" />

当您在最后一行的foo=上使用 hover 时，您应该看到文档。

游乐场示例。