是否在VSCode中的`exports.default`上损坏了JSDoc? [英] JSDoc broken on `exports.default` in VSCode?

查看:50
本文介绍了是否在VSCode中的`exports.default`上损坏了JSDoc?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我对VSCode和JSDocs有一种非常奇怪的体验。

显示命名导出的JSDocs信息,但不显示使用commonJS导出方法的默认导出的JSDocs信息。

问题: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 fn from './index'
fn // → no JSDoc info...

import { fn } from './index'
fn // → JSDoc info works

所以它适用于命名导入,但不适用于默认导入。

案例2:require()导入

let fn = require('./index')
fn // → no JSDoc info...

let fn = require('./index').fn
fn // → JSDoc info works

所以它适用于命名导入,但不适用于默认导入。

Gif以准确显示发生的情况

推荐答案

您应该使用:

import { default as fn } from "./exp";

这篇关于是否在VSCode中的`exports.default`上损坏了JSDoc?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆