Blog
JavaScript

Writing Effective JavaScript Comments

Best Practices for Code Documentation

Catalog

Click on this table of contents to jump to the corresponding section

JavaScript comments can be used to explain JavaScript code, and to make it more readable. JavaScript comments can also be used to prevent execution, when testing alternative code.

Single Line Comments

Single line comments start with //. Any text between // and the end of the line will be ignored by JavaScript (will not be executed). This example uses a single - line comment before each code line:

javascript

This example uses a single line comment at the end of each line to explain the code:

javascript

Multi - line Comments

Multi - line comments start with /* and end with */. Any text between /* and */ will be ignored by JavaScript. This example uses a multi-line comment (a comment block ) to explain the code:

javascript

Using Comments to Prevent Execution

Using comments to prevent execution of code is suitable for code testing.

Adding // in front of a code line changes the code lines from an executable line to a comment. This example uses // to prevent execution of one of the code lines:

javascript

This example uses a comment block to prevent execution of multiple lines:

javascript
avatar

0 Comments

No comments

Leave a Reply

avatar

Recent Post

Related Topics

    Feeds

      Don't miss what's next 👋

      Enjoyed this content? Leave your email to get notified when we publish new insights, tutorials, and updates — no spam, ever.