У меня очень странный опыт работы с VSCode и JSDocs.
Информация JSDocs отображается для именованных экспортов, но не для экспортов по умолчанию с помощью метода экспорта commonJS.
Проблема: нет всплывающего окна информацииexports.default
Файл: index.js
/**
* Some explanation
*
* @param {object} obj The obj has to be~~~ !
* @returns {void}
*/
function fn (obj) {
// ...
}
exports.fn = fn;
exports.default = fn;
Затем в другом файле:
Случай 1: import
import
import fn from './index'
fn // → no JSDoc info...
import { fn } from './index'
fn // → JSDoc info works
Таким образом, он работает с именованным импортом, но не по умолчанию.
Случай 2: require()
import
let fn = require('./index')
fn // → no JSDoc info...
let fn = require('./index').fn
fn // → JSDoc info works
Таким образом, он работает с именованным импортом, но не по умолчанию.
GIF, чтобы точно показать, что происходит