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

Remapping keyboard keys to avoid Carpal Tunnel

I am terrible at optimizing my keyboard layout for anything. But off lately, my little…

4 weeks ago

Fixing cookies are blocked for a website with shields down on Brave

I recently switched completely to the Brave browser and have set ad blocking to aggressive…

5 months ago

Generating a QR code using Node.js

I was preparing a slide deck for a hackathon and decided to put in a…

6 months ago

How to clear the global npx cache

I have been using npx a lot lately, especially whenever I want to use a…

6 months ago

Copy/Pasting output from the terminal

Manually copy-pasting the output of a terminal command with a mouse/trackpad feels tedious. It is…

7 months ago

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…

8 months ago
Advertisements