Перейти к основному содержимому

JSDoc

JSDoc — инструмент для документирования кода JavaScript и TypeScript.

Перед классом, функцией, методом, переменной и т.п. оставляется комментарий, начинающийся на две звёздочки: /** ... */. Внутри поддерживается Markdown.

Теги​

Для описания всего файла​

  • @fileoverview — краткое описание содержимого файла
  • @author — имя разработчика

Общего назначения​

  • @example — пример того, как может работать сущность
  • @see — описывает связь с другим объектом
  • @deprecated — маркирует сущность устаревшей и не рекомендуемой
  • @internal — маркирует сущность внутренней, не входящей в public API

Для функций и методов​

  • @param — описывает аргумент функции
  • @return — описывает возвращаемое значение
  • @throws — описывает исключения, выбрасываемые функцией

Актуальные только для JavaScript​

  • @type — маркер типа
  • @public, @private, @protected, @readonly — модификаторы доступа

Пример​

/**
 * Округляет число до заданного количества знаков после запятой.
 * @param n число, которое нужно округлить
 * @param digits количество знаков после запятой
 * @example
 * round(0.234, 2) => 0.23
 * round(234, -2) => 200
 */
function round(n: number, digits: number = 0): number {
  const multiplier = Math.pow(10, digits);
  return Math.round(n * multiplier) / multiplier;
}