webpack 后的 jsdoc 怎么写

在 webpack resolve 后,关联不到JSDoc的声明了(使用的VSCODE)
webpack 的 resolve
  resolve: {
    alias: {
      '@': path.join(__dirname, '../src/renderer')
    }
  }
state 模块的某个声明
  /**
   * @typedef {Object} User
   * @property {string} name 账号
   * @property {string} username 用户名
   * @property {string} password 密码
   * @property {number} auth 权限
   */

  /**
   * 用户
   * @type {Array<User>} user
   */
  users: [],
如果按这样的方式引入模块,则IDE没有智能提示
import state from '@/store/state'

img

如果不使用上述方式引入模块,而是如下方式引入,则IDE有智能提示
import state from './state'

img

请问如果是使用 @ 的方式引入,应该怎么写,才能正确让IDE识别到JSDoc ?

智能提示是编辑器携带的功能,和代码没有关系,你用的是什么编辑器?如果是vscode可以下载一个插件实现
https://blog.csdn.net/qq_41883423/article/details/125915604

jsdoc可以通过为代码加上特殊的注释来实现文档化,具体的项目文档地址在jsdoc官网上
最常用的就是@type注释和@param注释了,这里要使用的是@type注释来使ide判断类型。很多ide都支持jsdoc,比如vscode和webstorm,下面使用vscode来编写一个webpack的配置文件
安装webpack,新建webpack.config.js文件

img


使用@type注释一个对象然后导出

/**
 * @type {import('webpack').Configuration}
 */
const config = {
  
}

module.exports = config


这个时候在config里面是会有代码提示的

img


注意@type后面的类型引入用es6 import方式引入

额,解决了,配置好 jsconfig.json 的 baseUrl 和 paths 就可以了