用于jsDoc注释的正确套管是什么?

时间:2013-03-19 12:14:55

标签: case-sensitive google-closure-compiler jsdoc

我最近开始使用jsdoc注释来记录我们的javascript代码,但是我找到了@param标记用法的相互矛盾的例子。

https://code.google.com/p/jsdoc-toolkit/wiki/TagParam(PascalCase)

https://developers.google.com/closure/compiler/docs/js-for-compiler(驼峰/小写)。

从那以后,camelCase对我有意义:

var foo = 1;
console.log(typeof foo); // outputs "number"

用于jsDoc @param评论的正确套管是什么?或者没关系?我打算将它用于文档生成以及通过谷歌闭包运行代码来进行类型检查。

谢谢!

1 个答案:

答案 0 :(得分:16)

JSDoc类型表达式的冲突示例涉及JavaScript基元类型stringnumberboolean,它们具有相应的包装类型:StringNumber ,和Boolean

来自Closure: The Definitive Guide

  

Closure Library中禁止使用包装类型   如果使用包装类型,某些函数可能无法正常运行   预期原始类型。

请参阅MDN: Distinction between string primitives and String objects