【问题标题】:React: What is the naming convention to inform the return type of the function is jsx in the comments?React:在注释中通知函数的返回类型是 jsx 的命名约定是什么?
【发布时间】:2017-07-23 04:25:49
【问题描述】:

我相信大多数开发人员都遵循 JSDocs 推出的 JavaScript 评论指南。因此,这就是我通常为我创建的函数提供 cmets 的方式,以帮助可能在同一文件上工作的其他开发人员:

  /**
   * Renders the translated section in sidebar.
   *
   * @param {array} langList - List of languages to be rendered
   * @param {boolean} isTranslated - If true render translations
   * @return {JSX} - Returns JSX
   */
  _renderLangSection (langList, isTranslated) {
    return (
      <div>{isTranslated ? langlist : null}</div>
    );
  }

如你所见,这个函数的返回类型是 JSX。这是正确的返回类型吗?或者 React 元素 是一个更好的名字吗?有谁知道 React 社区喜欢什么?

【问题讨论】:

    标签: javascript reactjs comments


    【解决方案1】:

    如果调用返回类型为 JSX 也没关系,因为在使用 Babel 编译此函数后,JSX 代码将转换为纯 javascript

    function _renderLangSection (langList, isTranslated) {
      return React.createElement("div", null, isTranslated ? langlist : null);
    }
    

    最终返回一个 React 元素。

    【讨论】:

      【解决方案2】:

      返回值的Flow类型为React.Node,如VSCode中的tooltip叠加所示。

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2016-02-25
        相关资源
        最近更新 更多