17

我最近开始使用 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 注释使用的正确大小写是什么?还是没关系?我打算将它用于文档生成以及通过 google 闭包运行代码以进行类型检查。

谢谢!

4

1 回答 1

16

JSDoc 类型表达式的冲突示例涉及 JavaScript 原始类型和string,它们具有相应的包装器类型:、和。numberbooleanStringNumberBoolean

关闭:权威指南

闭包库中禁止使用包装器类型,因为如果在预期原始类型的地方使用包装器类型,某些函数可能无法正确运行。

请参阅 MDN:字符串原语和字符串对象之间的区别

于 2013-03-20T04:29:34.277 回答