Добавление комментариев в JavaScript: однострочные, многострочные комментарии и комментарии JSDoc

Вот несколько способов добавления комментариев в JavaScript:

  1. Однострочные комментарии: используйте двойную косую черту (//), чтобы добавить комментарии в одну строку. Все, что находится после косой черты, будет игнорироваться интерпретатором JavaScript.

Пример:

// This is a single-line comment
  1. Многострочные комментарии: поместите свои комментарии между /и/, чтобы создать многострочные комментарии. Это позволяет добавлять комментарии, занимающие несколько строк.

Пример:

/*
This is a multi-line comment.
It can span multiple lines.
*/
  1. Комментарии к документации: JSDoc — популярный формат, используемый для документирования кода JavaScript. Он позволяет добавлять структурированные комментарии, которые позже можно использовать для создания документации.

Пример:

/
 * This is a JSDoc comment. It can be used for documenting functions, classes, etc.
 * @param {number} x - A number input
 * @returns {number} - The squared value of the input
 */
function square(x) {
  return x * x;
}