What is the correct way of code comments in JavaScript

Question

What is the correct way of code comments in Javascript - is the same syntax as in Java? And which tools actually would take advantage of these comments:

  /*
  * Add an element to the group
  * @param {Object}  overlayElement
  * @param {Object} [element2] optional element
  */

I found new Resharper 6 (I write JS in VisualStudio 2010) offers the same comments as in C#, but only within the functions body, something like /// <param name="overlayElement"></param>. The JS code comments are not highlighted as such by ReSharper.

What is the best way to go ...?

Andrew Cameron · Accepted Answer · 2019-02-25 02:28:32Z

18

using // is better than /* */ because then you can use the latter to take out an entire block containing other comments. However, if you want to use an automatic documentation generation tool, you must use comments similar to javaDoc style.

This is an example that would work with YUI DOC (best one) https://yui.github.io/yuidoc/

/**
* This is a description
* @namespace My.Namespace
* @method myMethodName
* @param {String} some string
* @param {Object} some object
* @return {bool} some bool
*/

edited Feb 25, 2019 at 2:28

Andrew Cameron

771 silver badge12 bronze badges

answered Jul 25, 2011 at 12:23

Ilia Choly

18.6k14 gold badges95 silver badges166 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Horst Walter Over a year ago

So it is similar to javadoc, good to know. Thanks, to all who have helped.

Maciej Kravchyk Over a year ago

Your code editor should allow you to mark the text and take it out with // in each line (e.g. Ctrl + /). It will comment out everything no matter what was there.

bash- · Accepted Answer · 2011-07-25 12:14:31Z

7

good practice is to use // instead of /* */

The reason for that is because if you have */ in any part of the comment (assuming you do not intend to end yet), it would end the comment. This happens even if */ is in a string. i.e. "*/" <--- this would end the comment and would likely to give you a syntax error.

note // ends at a line break so you would need // for every line of comment.

answered Jul 25, 2011 at 12:14

bash-

6,33410 gold badges45 silver badges51 bronze badges

2 Comments

Steve Wellens Over a year ago

Note: Ctrl-K, Ctrl-C and Ctrl-K, Ctrl-U are handy shortcuts for commenting and uncommenting code.

TheBlackBenzKid Over a year ago

I disagree and prefer /* */ always.. minifiers.. and many reasons it always comes in handy.

margusholland · Accepted Answer · 2011-07-25 12:23:08Z

3

A good example is the Java based commenting still, which is also used with JSDoc. You can find examples here: http://code.google.com/p/jsdoc-toolkit/wiki/FAQ

To add simple onliners as comments, the // is still a good way to comment your code. But for generating documentation, I’d go with the JSDoc syntax. I have used it in the past and it works quite well.

answered Jul 25, 2011 at 12:23

margusholland

3,3781 gold badge26 silver badges31 bronze badges

Comments

Ayoub MOUSTAKIM · Accepted Answer · 2022-11-13 10:41:47Z

0

Comments in JavaScript are divided into two types: Single line comments or Multi-line comments:

the first is Single line comments start with // Example : let a = 25; // Declare x, give it the value of 25 var b= a -7 2; // Declare y, give it the value of a -7

the secondly is Multi-line comments start with /* Example: /* The code */

answered Nov 13, 2022 at 10:41

Ayoub MOUSTAKIM

91 bronze badge

2 Comments

Horst Walter Over a year ago

JFYI: The question (older than 10 years) was about the style to generate automatic documentation as in javadoc etc. Not about comments in general.

Community Over a year ago

Your answer could be improved with additional supporting information. Please edit to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers in the help center.

Collectives™ on Stack Overflow

What is the correct way of code comments in JavaScript

4 Answers 4

2 Comments

2 Comments

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

2 Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related