Javascript

Javascript Comments

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

• Asynchronous Operations in Javascript
• Javascript Logical Statements and Loops
• How Generator Functions work in Javascript
• Websockets Tutorial: Creating a real-time Websocket Server
• Resolving HTTP Cannot set headers after they are sent to the client in Node.JS
• An Introduction to Javascript
• Javascript Ordinals: Adding st, nd, rd and th suffixes to a number
• Check if an Object Contains all Keys in Array in Javascript
• Web Components and the Shadow DOM
• Making a Morphing 3D Sphere in Javascript with Three.js