React

How to write comments in React (JSX)?

Advertisements

I was recently trying to comment out some logic inside my JSX to add context about what a potentially complex logic. I then realized that comments in JSX are weird. So, how to write comments in React (JSX)?

You cannot use HTML comments because they are parsed as DOM nodes:

const doesNotWork = () => {
  return <!-- Does not work -->
}
const doesNotWork2 = () => {
  return (
    // not a valid comment
  )
}
JavaScript

How to write comments in React (JSX)

To write comments in React (JSX), we need to wrap them in curly braces.

const doesWork = () => {
  return {/* this works */ }
}
JavaScript

The curly braces tell the JSX parser to parse the code inside as JavaScript and not a string.

Multi-line comments in JSX

Since the contents inside are parsed as JavaScript, this enables us to also do multi-line or single-line comments:

const doesWork = () => {
  return <>
  {
    /*
      mult-line
      test
    */
  }
  {
      // single-line test
  }
  </>
}
JavaScript

In the case of a single-line comment, You cannot have the ending bracket in the same line because that will break everything.

Saransh Kataria

Born in Delhi, India, Saransh Kataria is the brain behind Wisdom Geek. Currently, Saransh is a software developer at a reputed firm in Austin, and he likes playing with new technologies to explore different possibilities. He holds an engineering degree in Computer Science. He also shares his passion for sharing knowledge as the community lead at Facebook Developer Circle Delhi, NCR which is a developer community in Delhi, India.

Share
Published by
Saransh Kataria

Recent Posts

How To Get The Hash of A File In Node.js

While working on a project, I wanted to do an integrity check of a file…

3 days ago

Native popover API in HTML

Popovers have been a problem that was typically solved by using a third-party solution. But…

1 week ago

Node.js 20.6 adds built-in support for .env files

Node.js 20.6 added built-in support for the .env file. This is an excellent addition to the platform…

3 weeks ago

Object destructuring in TypeScript

Object destructuring is a powerful ES 6 feature that can help developers write cleaner code.…

1 month ago

Improve git clone performance in a CI pipeline

Have you felt particularly annoyed by the time it takes to clone a large repository,…

1 month ago

Fix: Hydration failed because the initial UI does not match what was rendered on the server

Within a React or Next.js app, if you encounter the error "Hydration failed because the…

2 months ago
Advertisements