我正在添加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线程上列出的解决方案:How do I get VSCode to recognize current package Javascript imports?
不幸的是,这没有用,所以我想知道如何让JSDoc识别我的绝对页面路径,而不是我在导入时定义的相对页面路径。谢谢!
想通了。因此,这是我们配置Webpack识别~
//webpack config
config.resolve.alias = {
...config.resolve.alias,
'~': path.resolve(__dirname)
}
我相信通常JSdoc解析绝对文件路径不会有问题,但就我而言,我添加了tsconfig.json文件:
///tsconfig.json
{
"compilerOptions": {
"allowJs": true,
"baseUrl": ".",
"paths": {
"~/*": ["*"]
}
}
}
这成功了。抱歉,如果这让其他人感到困惑,在发布这篇文章之后,我才知道webpack的配置,但是在其他情况下,其他人也有类似的配置,并试图使JSDoc正常工作,这就是解决方案!