ES6 反应组件的 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 和构造函数......

“最佳”文档是否缺少更多标签？

Answer 1

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

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

这是倍数反应生活方式指南的列表

Answer 2

您可以将 JSDoc 与 Better-docs 主题/插件一起使用

• 它自动生成文档（自述文件和 HTML 页面）
• 高度可定制
• 组件的实时预览

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