Multi Line

Use /** ... */ for multi-line comments.

Examples

⇣ Incorrect code for this rule:

// Returns a new element based on the passed season name.
//
// @param {String} season
// @return {Element} element
function getElement(season) {
  // ...
  return element;
}

⇡ Correct code for this rule:

/**
 * Returns a new element based on the passed season name.
 *
 * @param {String} season - the name of the season
 * @return {Element} the element
 */
function getElement(season) {
  // ...
  return element;
}

Single Line

Use // for single line comments. Place single line comments on a newline above the subject of the comment. Put an empty line before the comment unless it's on the first line of a block.

Examples

⇣ Incorrect code for this rule:

const isSnowing = true;  // the current snow state.

function getWinterElement() {
  console.log("Loading winter elements...");
  // set the default type to "frost".
  const element = this.snow || "frost";

  return element;
}

⇡ Correct code for this rule:

// the current snow state.
const isSnowing = true;

function getWinterElement() {
  console.log("Loading winter elements...");

  // set the default type to "frost".
  const element = this.snow || "frost";

  return element;
}

function getWinterElement() {
  // set the default type to "frost".
  const element = this.snow || "frost";

  return element;
}

Spacing

Start all comments with a space to make it easier to read.

ESLint: spaced-comment

Examples

⇣ Incorrect code for this rule:

//the current snow state.
const isSnowing = true;

/**
 *Returns a new element based on the passed season name.
 *
 *@param {String} season - the name of the season
 *@return {Element} the element
 */
function getElement(season) {
  // ...
  return element;
}

⇡ Correct code for this rule:

// the current snow state.
const isSnowing = true;

/**
 * Returns a new element based on the passed season name.
 *
 * @param {String} season - the name of the season
 * @return {Element} the element
 */
function getElement(season) {
  // ...
  return element;
}