使用jsdoc帮助ide智能提示

最新推荐文章于 2023-12-05 21:35:35 发布

w2239559319

最新推荐文章于 2023-12-05 21:35:35 发布

阅读量494

点赞数

分类专栏：前端文章标签： javascript node.js webpack es6

本文链接：https://blog.csdn.net/w2239559319/article/details/114709421

版权

本文介绍如何利用jsdoc的type标志为JavaScript代码添加类型注释，以改善IDE如VSCode和WebStorm在处理webpack配置文件等场景时的智能提示。通过在对象前添加@type注解并导入相应的类型定义，可以为IDE提供对象类型的明确信息，从而实现更精确的代码补全和提示。

摘要由CSDN通过智能技术生成

在使用javascritp很多时候ide无法判断一个变量的类型或者是一个对象的具体类型（这里的类型指像ts中的interface），比如写webpack配置文件的时候，导出的对象往往没有提示。这里我们可以通过jsdoc的type标志来帮助ide确定对象的type

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

/**
 * @type

关注