JSDoc 注释未在绝对路径导入中显示

Question

我正在添加 JSDoc 函数文档，但在使用绝对页面路径导入函数时，无法显示我的文档注释。

JSDoc 函数：

/**
* Adds two numbers together and returns that value
* @param {number} a
* @param {number} b
* @return {number} returns the value of a plus b
*/
function addNums (a, b) {
 return a + b;
}

export { addNums }

使用相对页面路径：

import { addNums } from './addNums'

不适用于绝对页面路径：

import { addNums } from '~/lib/helpers/addNums'

我在实际代码中将路径从绝对路径更改为相对路径时的屏幕截图：

绝对页面路径： 相对页面路径： 我已经尝试了这个 SO 线程上列出的解决方案：

不幸的是，这没有用，所以我想知道如何让 JSDoc 识别我的绝对页面路径，而不是我在导入时定义的相对页面路径。谢谢！

Answer 1

想通了。所以这是我们配置 webpack 以识别 ~

的方式的问题

//webpack config

     config.resolve.alias = {
      ...config.resolve.alias,
      '~': path.resolve(__dirname)
    }

我相信通常 JSdoc 在解析绝对文件路径时没有问题，但在我的例子中，我添加了一个 tsconfig.json 文件：

   ///tsconfig.json

   {
    "compilerOptions": {
        "allowJs": true,
        "baseUrl": ".",
        "paths": {
            "~/*": ["*"]
        }
    }
}

这成功了。如果这让其他人感到困惑，我深表歉意，直到 post 之后我才知道 webpack 配置，但在偶然的情况下，其他人也有类似的配置并试图让 JSDoc 工作，这就是解决方案！

JSDoc 注释未在绝对路径导入中显示

JSDoc comments not showing on absolute path import

javascript

import

jsdoc

visual-studio-code