什么是在jsDoc注释中正确的大小写格式？

Question

17

最近我开始使用jsdoc注释来记录我们的javascript代码，但是我发现@ param标记的用法存在冲突的例子。

对我来说，camelCase很有道理，因为：

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

什么是jsDoc @param注释的正确大小写？或者大小写是否无关紧要？我计划将其用于文档生成以及通过Google关闭运行代码进行类型检查。

谢谢！

- magritte

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Christopher Peisert · Accepted Answer

JSDoc类型表达式的矛盾示例涉及JavaScript原始类型string，number和boolean，它们具有相应的包装类型：String，Number和Boolean。

在Closure Library中禁止使用包装类型，因为如果在期望基本类型的地方使用包装类型，则某些函数可能无法正确运行。