Вывод JSDoc как JSON для интеграции спа

Question

В настоящее время я создаю интернет-магазин с помощью node.js, и я хотел включить документацию по большей части всего моего прокомментированного кода javascript.Я могу легко создать документацию с помощью JSDoc и создать красивую HTML-документацию, но это не то, чего я хочу.

Я хочу создать навигацию на своем веб-сайте, где документация интегрирована в мой спа-центр.Поэтому я провел некоторое исследование и нашел несколько модулей npm, таких как jsdoc-x , которые создают JSON на основе комментариев JSDoc, но довольно загадочно и сложно создать правильную документацию.Использование jsdoc -X ./path/to/js/files> name.json также создает JSON-представление прокомментированного кода, но опять же очень загадочно и не очень практично.

Я ищу что-то вродеэто:

 /**
  * This is a function.
  *
  * @param {string} bar A parameter
  * @returns {string} A string
  */
  function foo(bar) {
      // do something...
      return bar;
  }

  /**
   * This is another function.
   *
   * @param {string} foo A parameter
   */
   function bar(foo) {
       // do something...
   }

должно создать что-то вроде этого:

  {
     "documentation": [
         {
             "function-name": "foo(bar)"
             "description": "This is a function.",
             "params": [
                 {
                    "param": "bar",
                    "description": "A parameter",
                    "type": "string"
                 }
             ],
             "returns": {
                 "description": "A string",
                 "type": "string"
             }
         }, 
         {
             "function-name": "bar(foo)"
             "description": "This is another function.",
             "params": [
                {
                   "param": "foo",
                   "description": "A parameter",
                   "type": "string"
                }
             ]
         }
     ]
  }

Таким образом, я мог бы создать ссылку под названием «documentmentaion», которая перечисляет все функции и их документацию внутри моего спа .