React 中如何在 JSX 树中写注释

本贴最后更新于 1920 天前,其中的信息可能已经时移世易

2019-02-27

回答

注释必须包裹在 {} 中并且使用 /* */ 语法,如下所示:

const tree = (
  <div>
    {/* Comment */}
    <p>Text</p>
  </div>
)

加分回答

  • 注释固然很重要, 但最好的代码应该就是文档本身。有意义的类型名和变量名, 要远胜于用注释去解释含糊不清的名字。注释应当解释代码为什么要这么做以及其目的。
  • 不要描述显而易见的现象,永远不要使用自然语言翻译代码作为注释,除非对高手来说此代码的主要功能都容易被忽略。在写注释时要假设读代码的人水平都高过于你。
  • TODO 是注释中很有用的一个,可以标记一些未完成的或不尽如人意的地方,空闲时就可以在 IDE 中顺着完成。
  • 注释应该尽量使用项目维护人员的母语或常用语。

返回总目录

30 秒面试系列一

  • 30Seconds

    📙 前端知识精选集,包含 HTML、CSS、JavaScript、React、Node、安全等方面,每天仅需 30 秒。

    • 精选常见面试题,帮助您准备下一次面试
    • 精选常见交互,帮助您拥有简洁酷炫的站点
    • 精选有用的 React 片段,帮助你获取最佳实践
    • 精选常见代码集,帮助您提高打码效率
    • 整理前端界的最新资讯,邀您一同探索新世界
    488 引用 • 383 回帖 • 3 关注
  • 面试

    面试造航母,上班拧螺丝。多面试,少加班。

    324 引用 • 1395 回帖 • 1 关注
  • React

    React 是 Facebook 开源的一个用于构建 UI 的 JavaScript 库。

    192 引用 • 291 回帖 • 438 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
Vanessa
我们终此一生,就是要摆脱他人的期待,找到真正的自己。 昆明