讲师中心 微信公众号
AI工具推荐 视频效率加速

JSDoc 中为动态类构造函数标注精确返回类型的完整指南

星磊君_4387

星磊君_4387

发布时间:2026-08-06 12:50:08

|

738人浏览过

|

来源于php中文网

原创

JSDoc 中为动态类构造函数标注精确返回类型的完整指南

在纯 javascript 中,jsdoc 目前无法精确描述「返回一个继承自传入类的动态匿名类」的类型,因缺乏对「类构造器类型」和「混合继承签名」的原生支持,导致 ide 无法完整推导实例方法来源。

在纯 javascript 中,jsdoc 目前无法精确描述「返回一个继承自传入类的动态匿名类」的类型,因缺乏对「类构造器类型」和「混合继承签名」的原生支持,导致 ide 无法完整推导实例方法来源。

JavaScript 的 class 表达式本质是构造函数,而 JSDoc 规范(截至 v4.0)未定义 @param {class} 或 {new (): T} 类型的标准化语义——{class} 在多数工具中被当作非标准写法,实际解析为 Function 或 any;@returns {UserProvidedClass} 则仅表示“返回该类的实例”,而非“返回一个扩展了该类的新构造函数”。

这意味着,以下写法虽语法无误,但类型提示严重失真:

/**
 * ❌ 错误:@returns {UserProvidedClass} 仅表示返回其*实例*,
 *       而函数实际返回的是*构造函数*,且新类方法(如 bindServerSocket)
 *       在 VS Code 等工具中完全不可见。
 * @param {Function} UserProvidedClass
 * @returns {UserProvidedClass}
 */
function createClientClass(UserProvidedClass) {
  return class ClientClass extends UserProvidedClass {
    bindServerSocket(socket) { /* ... */ }
    onConnect() { /* ... */ }
  };
}

✅ 可行的折中方案(基于当前工具链)

虽然 JSDoc 无官方语法支持「构造函数泛型」或「多重继承类型合并」,但主流编辑器(如 VS Code + TypeScript language service)可通过以下方式显著提升类型感知能力:

1. 使用 @template + @constructor + @extends 组合声明(推荐)

/**
 * 创建一个继承自 UserProvidedClass 的客户端类,并注入连接生命周期方法。
 * @template {new (...args: any[]) => any} T
 * @param {T} UserProvidedClass - 用户提供的基类构造函数
 * @returns {new (...args: ConstructorParameters<T>) => InstanceType<T> & {
 *   bindServerSocket: (socket: WebSocket) => void;
 *   onConnect: () => void;
 * }}
 */
function createClientClass(UserProvidedClass) {
  return class ClientClass extends UserProvidedClass {
    bindServerSocket(socket) {
      this.server = socket;
      this.onConnect();
    }
    onConnect() {
      super.onConnect?.();
      if (DEBUG) console.log('client connected');
    }
  };
}

✅ 效果:VS Code 能正确识别 instance.bindServerSocket() 和 instance.test()(来自 CustomClass),前提是:

  • 项目根目录存在 jsconfig.json(启用 checkJs: true 和 allowJs: true);
  • CustomClass 是具名类(非匿名表达式),且定义在可解析作用域内。

2. 避免过度依赖 @template 复杂签名

若上述泛型写法在旧版工具中失效,更稳健的做法是显式声明混合类型接口(不创建真实类,仅作类型占位):

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
/**
 * @typedef {InstanceType<CustomClass> & {
 *   bindServerSocket: (socket: WebSocket) => void;
 *   onConnect: () => void;
 * }} ClientClassInstance
 *
 * @param {typeof CustomClass} UserProvidedClass
 * @returns {typeof CustomClass & {
 *   new (...args: ConstructorParameters<typeof CustomClass>): ClientClassInstance
 * }}
 */
function createClientClass(UserProvidedClass) {
  // 实现不变...
}

⚠️ 注意事项:

  • @typedef 定义需置于模块顶部或全局作用域,确保被所有引用处可见;
  • typeof CustomClass 是合法 JSDoc 类型(表示构造函数类型),但要求 CustomClass 必须已声明;
  • 此方案牺牲一定灵活性(需为每个基类单独定义 @typedef),但兼容性最佳。

总结与现状说明

JSDoc 当前确实无法实现 TypeScript 中 ReturnType<typeof createClientClass<CustomClass>> 的等效能力。核心限制在于:

  • 无 new () => T 构造函数类型字面量的标准化支持;
  • @template 不支持约束为「类构造器」(即 T extends new () => any);
  • @extends 仅用于类定义,不能用于 @returns 类型表达式。

因此,实践中应:

  • 优先采用 @template + InstanceType<T> & {...} 显式交叉类型(现代 VS Code / WebStorm 支持良好);
  • 对于严格类型环境,考虑迁移到 TypeScript(.ts 或 // @ts-check);
  • 避免使用 @param {class} 等非标准标签——改用 {Function} 或 {typeof SomeClass}。

最终,这不是 JSDoc “用法错误”,而是规范与工具链演进尚未覆盖动态类建模这一高级模式。保持关注 JSDoc Issue #1349 是获取未来原生支持的唯一途径。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4466

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1109

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4384

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

880

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1776

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3225

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4193

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2700

2023.09.20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

40

2026.09.30

热门下载

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

精品课程

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

共101课时 | 20.7万人学习

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

共39课时 | 4.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn