jsdoc有效的param类型

Question

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

@param {type} myParam Some parameter description

我知道类似number和String有效的东西,但如果我想记录数字是整数怎么办.是否int有效？

我做了一些谷歌搜索,但我似乎无法找到一个完整的列表.

Answer 1

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

你可以坚持使用JavaScript类型,如果你想要{Number},或者如果你想指定你可以做{integer} ...我可能会建议像:

@param {Number} myParam must be an integer

干杯

我注意到工具通常只是对字符串进行标记,所以它并不重要.我只是希望有一些标准的类型.javascript类型系统看起来不够表达(例如,Number不是非常具体),但是有如上所示的选项. (3认同)
一个人可以把任何东西都放在{}中,但知道约定是什么可能会很好,不是吗？真的没有名单吗？就像有一个规范Prototype对象的约定,或者应该是@param {Object} ......？ (3认同)
对于JSDoc生成器(https://github.com/jsdoc3/jsdoc),在http://usejsdoc.org/tags-param.html中说,"参数类型可以是内置的JavaScript类型,例如字符串或对象,或代码中另一个符号的JSDoc名称路径." 如果代码中包含符号,则会为其定义生成链接.但是,内置类型仍然显示为字符串,因此没有真正的区别,例如`{string}`和`{String}`.另外,例如,PhpStorm同时识别它们,但在接受`{Array}`时抱怨`{array}`. (3认同)

Answer 2

回答实际问题

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

这里的@param状态文档,您可以使用内置类型和"名称路径 "(您之前创建/记录的类型的ak路径以及您声明的类型.@type

如果你查找built-in Javascript types,你得到以下内容,例如在这里,你得到基本类型的列表:

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

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