如何通过 JSDoc 配合类型检查在不使用 TypeScript 时提升代码维护性

浅伟大大_5016

浅伟大大_5016

2026-04-14

558人浏览

原创

能,且效果实在——需配置到位、注解精准:启用 // @ts-check 或 jsconfig.json 中设 "checkjs": true 和 "strict": true;@param/@returns 必带花括号类型,对象须写全,异步函数需标 promise;注释须紧贴声明无空行,箭头函数用 @type 断言,导出推荐先声明后 export。

如何通过 jsdoc 配合类型检查在不使用 typescript 时提升代码维护性

能,而且效果很实在——前提是配置到位、注解写得准,不是光加个 /** */ 就完事。

VS Code 里怎么让 JSDoc 真正报错?

很多人加了 @param {string} name 却没任何提示,根本原因是没启用检查。VS Code 默认不主动校验 JS 文件的类型一致性。

  • 在文件顶部加一行 // @ts-check,当前文件立即启用类型检查(包括参数类型、返回值、赋值兼容性)
  • 如果想整个项目都生效,必须配 jsconfig.json,且 "checkJs": true 不可少;漏掉这句,// @ts-check 也会失效
  • jsconfig.json 中的 "strict": true 不是可选——它控制是否检查隐式 any、是否允许 undefined 赋给非可选字段等细节,不开启等于关掉一半能力

@param 和 @returns 怎么写才不会被 eslint-plugin-jsdoc 报错?

eslint-plugin-jsdoc 的 require-param-type 和 require-returns-type 规则很严格:只写 @param name 不行,必须带花括号类型;只写 @returns 也不行,必须写成 @returns {number}。

Wjs Uploading Video
Wjs Uploading Video

将一个或多个视频上传至YouTube。当用户想“上传到YouTube”“发YouTube”“批量上传”“upload to YouTube”“post videos to YouTube”或发布到YouTube时使用此技能。

下载
  • 对象类型要写全,比如 @param {{ id: number, name: string }} user,不能简写成 @param {object} user(object 被视为无效类型)
  • 可选属性用方括号:@param {{ name: string, [key: string]: any }} opts,否则 check-types 会报错
  • 异步函数别漏 Promise:应写 @returns {Promise<string>}</string>,写成 @returns {string} 会被 require-returns-type 拦下

为什么写了 JSDoc 还是没智能提示?

常见原因不是注解格式错,而是编辑器没“看到”它——尤其当函数定义和注解之间夹了空行、注释位置不对,或用了错误的注释块。

  • JSDoc 注释必须紧贴函数/变量声明上方,中间不能有空行,也不能是 // 行注释
  • 箭头函数无法直接绑定 JSDoc,得写成命名函数或用 /** @type {function(string): number} */ 这种类型断言方式
  • 导出的函数如果写在 export default function foo() {} 上方,VS Code 有时识别不稳定;稳妥做法是先声明再导出:function foo() {}; export { foo };
  • 确保没有全局 noImplicitAny: false 类配置覆盖了 jsconfig.json 的 strict 设置

最容易被忽略的一点:JSDoc 类型检查不是“写完就稳”,它高度依赖上下文推断。比如一个参数类型靠函数调用处传入的字面量反推,一旦传参是变量或来自其他模块,类型链就容易断。这时候必须手动补全 @type 或嵌套 @typedef,否则提示和检查都会弱化。这不是缺陷,而是轻量方案的合理边界。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3089

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2288

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1220

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1178

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2118

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3380

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15295

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.9万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习