Skip to main content

JSDoc

JSDoc - це мова розмітки, яка використовується для анотування вихідного коду JavaScript з використанням коментарів. Анотації обробляються різними інструментами для створення документації у доступних форматах, таких як HTML та Rich Text Format.

Основні параметри​

  • @method - HTTP-метод для запиту
  • @summary - Короткий опис
  • @description - загальний опис документованого коду
  • @priority - Пріоритет (1 - найнижчий, 5 - найвищий)
  • @alias - Назва
  • @tag - Теги
  • @type - Тип
  • @requires - Require
  • @example - приклади
  • @param - дозволяє вказати ім'я (обов'язково), тип та опис параметру функції. Синтаксис: @param {Тип} Ім'я - Опис
  • @errors - вказуються доступні помилки
  • @returns - описуються значення, що повертаються функцією. Синтаксис: @returns {Тип}

Заповнений приклад​

/**
 * Отримується результат від id.gov.ua з хешем до користувача
 *
 * @method GET|POST
 * @summary Авторизує користувача через id.gov.ua
 * @priority 2
 * @alias by_govua
 * @type api
 * @tag auth
 * @requires loginUser
 * @param {String} data Хеш для отримання информації
 * @param {String} state Додаткова інформація передана при авторизації
 * @errors 301,500
 * @returns {Number} status Номер помилки
 * @returns {String|Object} error Опис помилки
 * @returns {String|Object} message Повідомлення про успішне виконання або об'єкт з параметрами
 * @returns {String} redirect Шлях до переадресації
 * @returns {Object} headers Заголовки HTTP
 */

Формування документації з JSDOC​

Прописані JSDoc до коду автоматично зберігаються в базу даних та відображається на порталі https://help.softpro.ua