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

mag*_*tte 17 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(camel/lowercase).

camelCase对我来说很有意义:

var foo = 1;
console.log(typeof foo); // outputs "number"
Run Code Online (Sandbox Code Playgroud)

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

谢谢!

Chr*_*ert 16

对于JSDoc类型表达式冲突示例涉及JavaScript的原始类型string,number并且boolean,它们具有相应的包装类型:String,Number,和Boolean.

关闭:权威指南:

Closure库中禁止使用包装器类型,因为如果在期望基本类型的地方使用包装器类型,某些函数可能无法正常运行.

请参阅MDN:字符串基元和String对象之间的区别.

  • 在大多数情况下,您需要基本类型而不是对象类型.编译器将在必要时自动选中(提升)基元类型,但反之则不然. (4认同)
  • 那么'功能'呢? (3认同)