Javascript Comments
📣 Sponsor
Throughout all of our tutorials and articles, we use comments extensively in our code examples. Commenting lets us add descriptive text to our code so we can remember or tell others why we did what we did. There are a few ways to write comments in Javascript.
How to comment code
Below is an example of how to comment your code:
// Anything written after a double slash is a commenting
// It will be ignored by the Javascript parser, so it lets us add details to why we did what we did.
// The below line is not commented, so will be parsed.
let i = 1;
Another way to comment..
We can also use /*
and */
:
/*
This is a comment block
Everything within this is a comment
And can be safely ignored by Javascript
*/
let i = 1;
Why is commenting important?
When we write code, we know exactly why we are doing things, but upon looking at it again, it can be quite confusing why we did anything at all. Comments give context not only to us, but anyone else who picks up this code in the future. That let's everyone work better together, and means your code is much easier to understand.
More Tips and Tricks for Javascript
- The Javascript API to Access a User's Local Files
- Creating 3d Animated Gradient Effects with Javascript and WebGL
- Javascript innerHTML
- Javascript Variables
- How to Check if Object is Empty in JavaScript
- What is Nullish Coalescing (or ??) in Javascript
- Removing the last element of an array in Javascript
- How to check if a user has scrolled to the bottom of a page with vanilla Javascript
- Using an Array as Function Parameter in JavaScript
- Javascript Array Every Method