jsdoc有效的param类型

Question

jsdoc的param标签有哪些有效类型的列表？例如，

@param {type} myParam Some parameter description

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

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

Answer 1

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

如果您想要{Number}，或者如果您想指定可以执行{integer}，您可以坚持使用JavaScript类型......我可能会推荐类似的内容：

@param {Number} myParam must be an integer

欢呼声

Answer 2

回答实际问题

  

是否存在jsdoc的param标签的有效类型的列表？

@param州here的文档，您可以使用内置类型和＆＃34; namepaths＆＃34; （a.k.您之前创建/记录的类型的路径以及您使用@type声明的类型。

如果您查找built-in Javascript types，则会得到以下内容，例如here，您将获得基本类型列表：

• 布尔
• 空
• 未定义
• 数
• 字符串
• 符号（ECMAScript 2015中的新内容）
• 对象

这里有一些名称路径的例子：

• exampleFunction
• ExampleClass中＃someInstanceMember
• exampleClass.staticMember
• ExampleClass中〜innerMember

E.g。 @param {exampleClass} exampleParam Instance of your example class