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

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

云晨姑娘_9874

云晨姑娘_9874

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

|

1035人浏览过

|

来源于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)均能正确推导类型。

Revealjs Presentations
Revealjs Presentations

创建、编辑并部署 reveal.js 演示文稿为单个 HTML 文件,可选自定义 CSS。适用于需要制作演示文稿、幻灯片或宣传材料时使用。

下载

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

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

/**
 * @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工具

更多
WorkBuddy

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

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

相关专题

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

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

252

2026.02.13

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

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

460

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

311

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

226

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

478

2026.06.16

string转int
string转int

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

5199

2023.08.02

scripterror怎么解决
scripterror怎么解决

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

889

2023.10.18

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

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

2360

2023.10.25

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

20

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 11.9万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习

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

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