11
Сен
2021

Почему JSDoc не видит локальные комментарии?

В коде ниже генератор документации jsdoc не видит локальные комментарии к функциям и переменным.

document.addEventListener("DOMContentLoaded", function () {
    /**
   * Конвертирует Rem в Пиксели
   * @param   {Number} rem Сколько rem сконвертировать в пиксели
   * @returns {Number} Кол-во сконвертированных пикселей
   */
  function convertRemToPixels(rem) {
    return rem * parseFloat(getComputedStyle(document.documentElement).fontSize);
  }
});

То есть при компиляции чистое окно: image

Когда же обёртывающей функции нет, JSDoc видит и можешь прочесть эти комментарии:

/**
 * Конвертирует Rem в Пиксели
 * @param   {Number} rem Сколько rem сконвертировать в пиксели
 * @returns {Number} Кол-во сконвертированных пикселей
 */
function convertRemToPixels(rem) {
  return rem * parseFloat(getComputedStyle(document.documentElement).fontSize);
}

console.log(convertRemToPixels(2))

image

jsdoc.json:

{
  "source": {
    "include": "./src/js/main.js",
    "excludePattern": "(node_modules/|docs|dist)"
  },
  "plugins": ["plugins/markdown"],
  "templates": {
    "cleverLinks": true,
    "monospaceLinks": true
  },
  "opts": {
    "recurse": true,
    "destination": "./docs/",
    "readme": "./readme/readme.md"
  }
}

Как исправить такое поведение JSDoc? Если не знаете ответа, посоветуйте генератор документации каким пользуетесь вы. Спасибо!

Источник: https://ru.stackoverflow.com/questions/1327509/%D0%9F%D0%BE%D1%87%D0%B5%D0%BC%D1%83-jsdoc-%D0%BD%D0%B5-%D0%B2%D0%B8%D0%B4%D0%B8%D1%82-%D0%BB%D0%BE%D0%BA%D0%B0%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5-%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B8

Тебе может это понравится...

Добавить комментарий