62

jsdoc的参数标签是否有有效类型的列表？例如，

@param {type} myParam Some parameter description

我知道 和 之类的东西number是String有效的，但是如果我想记录这个数字是一个整数怎么办。int有效吗？

我做了一些谷歌搜索，但似乎找不到完整的列表。

4

2 回答 2

38

无论如何，我使用的 JS 文档工具只是将注释标记为字符串，从而可以在 {type} 部分中放置您想要的任何内容。

如果你想要 {number} 或 {string}，你可以坚持使用 JavaScript 类型，或者如果你想指定你可以做 {integer}... 但我可能会推荐类似的东西：

@param {number} myParam must be an integer

干杯

于 2013-01-03T00:28:59.877 回答
29

回答实际问题

jsdoc的参数标签是否有有效类型的列表？

此处@param的状态文档表明您可以使用内置类型和“名称路径”（指向您之前创建/记录的类型的路径以及您使用.@type

如果您查找built-in Javascript types，您会得到以下内容，例如在这里，您会得到原始类型的列表：

  • 布尔值
  • 空值
  • 不明确的
  • 数字
  • 细绳
  • 符号（ECMAScript 2015 中的新功能）
  • 目的

以下是一些名称路径示例：

  • 示例函数
  • exampleClass#someInstanceMember
  • exampleClass.staticMember
  • exampleClass~innerMember

例如@param {exampleClass} exampleParam Instance of your example class

于 2018-05-29T17:42:33.673 回答