Javascript 当键名为event时，我的 JSDoc 类型出现语法错误

发布于07月20日

下面是eslint的jsdoc插件不喜欢的一个jsdoc:

@property {{event: Object.<string, MyEnum[]>, observation: Object.<string, MyEnum[]>}} enums

它抱怨:Syntax error in type: (...) jsdoc/valid-types

如果我将"Event"重命名为"Events"，它将再次工作.

你知道为什么我不能有一个名为"Event"的对象键吗？

SOLVED (by andrew arrow, see his solution below):个

多亏了@Andrew Arrow，我最终像这样分解了我的"enum"密钥，它不再抱怨了:

@property {Object} enums
@property {Object.<string, MyEnum[]>} enums.event
@property {Object.<string, MyEnum[]>} enums.observation

谢谢安德鲁！

推荐答案

该问题特定于JSDoc注释和ESLint JSDoc插件.该插件可能会错误地将"事件"解释为其他内容，从而触发"语法错误类型"的投诉！

try JSDoc注释的另一种语法，看看它是否正常工作，没有任何错误.不使用属性的内联类型表示法，而是将@type标记与MyEnum的单独@tyecif一起使用:

/**
 * @typedef {Object.<string, MyEnum[]>} MyEnumObject
 * @property {MyEnumObject} event
 * @property {MyEnumObject} observation
 *
 * @type {{
 *   event: MyEnumObject,
 *   observation: MyEnumObject
 * }}
 */
const enums = {
  // Your object initialization here
};