JSDoc 在 VSCode 的 `exports.default` 上损坏了?

问题描述 投票:0回答:2

我对 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;

然后在另一个文件中:

案例一:
import
导入

import fn from './index'
fn // → no JSDoc info...

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

因此它适用于命名导入,但不适用于默认情况。

案例二:
require()
导入

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

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

因此它适用于命名导入,但不适用于默认情况。

Gif 来显示究竟发生了什么

javascript visual-studio-code export require jsdoc
2个回答
0
投票

你应该使用:

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

0
投票

我没有检查,但根据这个 GitHub 问题,该错误已被修复。

https://github.com/microsoft/TypeScript/issues/41216

© www.soinside.com 2019 - 2024. All rights reserved.