Comments In JavaScript - JavaScript Tutorials

About About Introduction Introduction Enabling and Embedding Comments Literals Types of Literals Integer Literals Floating-Point Literals Boolean Literals String Literals Escaping Literals Operators Types of Operators Assignment Operators Comparison Operators Arithmetic Operators Logical Operators Variables Variables and usage Values of Variables Data Type Conversion Arrays Arrays Functions What are Functions Defining a Function Calling a Function Objects Objects Conditional statements If Else Else..If Switch Loop statements While Do-while For For-in Break Continue

How to use comments in JavaScript

Comments allow you to write notes to yourself within your program. These are important because they allow someone to browse your code and understand what the various functions do or what your variables represent. Comments also allow you to understand your code if it's been a while since you last looked at it.

For a multiple-line comment, you start with /* and end with */ . It is nice to put an * at the beginning of each line just so someone perusing your code realizes that he/she is looking at a comment (if it is really long this helps). This is not necessary though.