ES6 React组件的JSDoc

Question

我认为React组件的JSDoc注释应该长这样：

/**
 * My component...
 *
 * @namespace MyComponent
 * @memberof app.components
 */
app.components.MyComponent = React.createClass({
    })

但是如果我使用 ES6，它应该长得像什么？

/**
 * My component...
 *
 * @namespace MyComponent
 * @memberof ??
 */
    class MyComponent extends Component {
      /**
       * PropTypes
       * @param {string} element
       */
      static propTypes = {
          element: PropTypes.object
      }

      /**
       * Constructor
       * How to take care about onChange and states?
       */
      constructor () {
        super()
        this.onChange = this.onChange.bind(this)
        this.state = {
          anything: true
        }
      }
    }

此外，我不理解如何记录静态propTypes和构造函数...

是否还有其他标签缺失，以实现“最佳”文档记录？

- user3142695

Answer 1

由于您正在使用ES6模块，因此无需指定命名空间或“@memberof”。

有一个 jsdoc-react，但我建议使用交互式组件样式指南，例如 styleguidist，它处理jsdoc和proptypes。 根据他们的文档，他们不评论构造函数。

这里是多个反应生活样式指南列表

- Palisanka

Answer 2

你可以使用better-docs主题/插件与JSDoc一起使用。

它可以自动生成文档（Readme和HTML页面）。

高度可定制化。

您的组件可以进行实时预览。

在这里查看：https://www.inkoop.io/blog/a-guide-to-js-docs-for-react-js/。

- Jittu

---

虽然这个链接可能回答了问题，但最好在此处包含答案的基本部分并提供参考链接。仅有链接的答案如果链接页面发生更改可能会变得无效。 - csabinho