JSDoc：属性名称

Question

是否可以使用特殊符号（例如＆＃34; +＆＃34;）对属性进行正确描述。在jsdoc？

示例：

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

＆＃34;编号+名称＆＃34;在这种情况下似乎是无效的语法。

Answer 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团队的其他人或某人会提供更好的想法。