jsdoc有效的参数类型

jsdoc的param标签有没有一个有效的类型列表？例如，jsdoc有效的参数类型

@param {type} myParam Some parameter description

我知道事情像number和String是有效的，但如果我想记录的数量是一个整数什么。 int有效吗？

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

来源

2013-01-02 Jeff Storey

我使用的JS文档工具只是将注释标记为字符串，因此可以在{type}部分添加任何您想要的内容。

你可以使用JavaScript类型的坚持，如果你想要像{}号，或者如果你想指定你可以做{整数} ...我可能会建议是这样的：

@param {Number} myParam must be an integer

欢呼

来源

2013-01-03 00:28:59 hunterloftis

我注意到工具通常只是标记字符串，所以它并不重要。我只是希望有一些标准的类型。 JavaScript类型的系统似乎表现得不够明显（例如，数字不是很具体），但是有如上所示的选项。 –

可以在{}内放置任何东西，但是可能很高兴知道约定是什么，不是吗？真的没有名单吗？像是有一个指定Prototype对象的约定，或者应该是@param {Object} ...？ – fraxture

对于JSDoc生成器（https://github.com/jsdoc3/jsdoc），在http://usejsdoc.org/tags-param.html中表示：“参数类型可以是内置JavaScript类型，例如作为字符串或对象，或者代码中另一个符号的JSDoc名称路径。“如果代码中有符号，则会为其定义生成链接。但是，内置类型仍然显示为字符串，因此没有真正的差别，例如在'{string}'和'{String}'之间。另外，例如，PhpStorm可以识别它们，但在接受'{Array}'时抱怨'{array}'。 –

jsdoc有效的参数类型

回答

相关问题