0

0

JSDoc 类型定义中键名 "event" 引发语法错误的解决方案

碧海醫心

碧海醫心

发布时间:2026-01-10 20:47:02

|

995人浏览过

|

来源于php中文网

原创

JSDoc 类型定义中键名

eslint 的 `jsdoc/valid-types` 规则会将对象字面量类型中名为 `event` 的键误识别为保留关键字或内部标识符,导致解析失败;可通过拆分 `@property` 声明、使用 `@typedef` 抽离类型,或改用 `@type` + 字面量注解等方式规避该限制。

在 JavaScript 项目中使用 JSDoc 进行类型标注时,你可能会遇到一个看似奇怪的限制:当对象类型定义中包含键名为 "event" 时(例如 {event: Object.<string, MyEnum[]>}),ESLint 的 jsdoc/valid-types 规则会抛出 Syntax error in type 错误,而将键名改为 "events" 或 "evt" 却能正常通过。这并非 JavaScript 语法问题,而是 ESLint 的 JSDoc 插件(如 eslint-plugin-jsdoc)在解析类型字符串时存在关键字冲突或解析歧义——它可能将 "event" 误判为内置事件相关标识符(如 Event 构造函数、event 参数名等),从而提前终止类型解析。

✅ 推荐解决方案(按优先级排序)

1. 拆分为独立 @property 声明(最简洁、兼容性最佳)

避免在单个内联对象类型中声明 event 键,转而为每个属性单独注解:

/**
 * @property {Object} enums
 * @property {Object.<string, MyEnum[]>} enums.event
 * @property {Object.<string, MyEnum[]>} enums.observation
 */
const enums = {
  event: { /* ... */ },
  observation: { /* ... */ }
};

✅ 优势:无需修改变量结构,完全绕过内联对象解析器缺陷;所有主流工具(VS Code、TypeScript、ESLint)均能正确推导类型。

2. 使用 @typedef + @type 组合(语义清晰、可复用)

将复杂类型抽离为命名类型,再通过 @type 显式标注变量:

Sora
Sora

Sora是OpenAI发布的一种文生视频AI大模型,可以根据文本指令创建现实和富有想象力的场景。

下载
/**
 * @typedef {Object.<string, MyEnum[]>} MyEnumMap
 *
 * @type {{
 *   event: MyEnumMap,
 *   observation: MyEnumMap
 * }}
 */
const enums = {
  event: {},
  observation: {}
};

⚠️ 注意:确保 MyEnum 已正确定义(如通过 @enum 或外部类型声明),否则 MyEnumMap 可能被误报为未定义类型。

3. 替代语法:改用 Record(TypeScript 用户推荐)

若项目已启用 TypeScript 支持,可使用更现代的泛型语法提升可读性与健壮性:

/**
 * @type {Record<'event' | 'observation', Record<string, MyEnum[]>}
 */
const enums = { /* ... */ };
? 提示:Record 是 TypeScript 内置工具类型,在支持 JSDoc 的 TS 环境中解析稳定,且不会触发 event 关键字误判。

⚠️ 注意事项

  • 不要依赖 @property {{event: ...}} 这类内联对象字面量写法中的敏感键名(如 event, class, function, return),它们在部分 JSDoc 解析器中属于高风险词。
  • ESLint 插件版本影响显著:升级至 eslint-plugin-jsdoc@40+ 可缓解部分解析问题,但仍建议采用上述防御性写法。
  • 若使用 VS Code,拆分式 @property 注解能提供更精准的悬停提示和自动补全支持。

通过结构化声明替代紧凑内联类型,不仅规避了工具链的解析陷阱,也让 JSDoc 更易维护、协作更清晰——类型即文档,清晰胜于简短。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

192

2026.02.25

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1030

2023.08.02

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

492

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

382

2023.10.25

mysql标识符无效错误怎么解决
mysql标识符无效错误怎么解决

mysql标识符无效错误的解决办法:1、检查标识符是否被其他表或数据库使用;2、检查标识符是否包含特殊字符;3、使用引号包裹标识符;4、使用反引号包裹标识符;5、检查MySQL的配置文件等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

210

2023.12.04

Python标识符有哪些
Python标识符有哪些

Python标识符有变量标识符、函数标识符、类标识符、模块标识符、下划线开头的标识符、双下划线开头、双下划线结尾的标识符、整型标识符、浮点型标识符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

322

2024.02.23

java标识符合集
java标识符合集

本专题整合了java标识符相关内容,想了解更多详细内容,请阅读下面的文章。

292

2025.06.11

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号