我最近开始使用jsdoc注释来记录我们的javascript代码,但是我发现了@param标记的用法的冲突示例。什么是jsDoc评论的正确使用方法?
参见https://code.google.com/p/jsdoc-toolkit/wiki/TagParam(PascalCase)
https://developers.google.com/closure/compiler/docs/js-for-compiler和(骆驼/小写)。
驼峰对我来说很有意义,因为:
var foo = 1;
console.log(typeof foo); // outputs "number"
什么是用于jsDoc @param意见正确的外壳?或者没有关系?我打算将它用于文档生成以及通过谷歌关闭运行代码以获取类型检查。
谢谢!
在大多数情况下,您需要原始类型而不是对象类型。编译器会在必要时自动对原始类型进行加框(提升),但反过来不是这样。 – 2013-03-20 15:03:00
谢谢cpeisert!我一定要拿到那本书! – magritte 2013-03-20 19:44:56
绝对要做。这是一个很棒的阅读,而不仅仅是它的封闭信息! – jordancpaul 2013-04-06 09:06:45