JSDoc：属性名称答案

【问题标题】：JSDoc: property nameJSDoc：属性名称
【发布时间】：2017-08-05 23:22:14
【问题描述】：

有没有办法对 jsdoc 中带有“+”等特殊符号的属性进行正确的描述？

例子：

/**
  * @typedef {Object} TestObject
  * @property {string} "id+name"
  */

"id+name" 在这种情况下似乎是无效的语法。

【问题讨论】：

标签： javascript documentation jsdoc jsdoc3

【解决方案1】：

您需要根据文档查看@property 是什么。基本上这是一个类中的变量名。正确的？在这种情况下，您应该遵循 JS 对变量名的约定。这是对帖子的参考发现它...What characters are valid for JavaScript variable names?。显然变量名“id+name”是无效的。以下是该属性的访问器...

TestObject.id+name // fail
TestObject["id+name"] // would work for most of the browsers

JSDoc 创建者的问题，他们如何验证特定类型@property 标记的属性。我坚信他们会为变量名指出相同的 JS 约定。果然，您可能不接受它作为您问题的答案。也许其他人或来自 JSDoc 团队的人会提供更好的想法。

【讨论】：

顺便说一下，第二个是有效的访问器，这就是重点。
@shadeglare 是的，你说得对，这适用于大多数浏览器，但 JSDoc 不喜欢它，所以 intellisense 不知道在键入“TestObject.”时要显示什么。不确定创建这样的变量的原因。只是为了理论？无论如何，谢谢指点，我会修改答案。