JSDoc:属性名称

sha*_*are 5 javascript documentation jsdoc jsdoc3

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

例子:

/**
  * @typedef {Object} TestObject
  * @property {string} "id+name"
  */
Run Code Online (Sandbox Code Playgroud)

在这种情况下,“id+name”似乎是无效语法。

Dra*_*SAN 2

看起来您可以使用类似 TypeScript 的语法来更好地支持这种情况

https://github.com/BeyondCodeBootcamp/js-with-types-jsdoc-tsc-starter/issues/3

/**
 * @typedef {{
 *   "Emp#": string,
 *   "First Name": string,
 * }} EmpCsv
 */
Run Code Online (Sandbox Code Playgroud)

虽然纯粹的打字稿解决方案是:

interface EmployeeCsv {
  "Emp#": string,
  "First Name": string,
}
Run Code Online (Sandbox Code Playgroud)