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/