【问题标题】:What's the correct casing to use for jsDoc comments?用于 jsDoc 注释的正确大小写是什么?
【发布时间】:2013-03-08 02:41:46
【问题描述】:

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

谢谢!

【问题讨论】:

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


    【解决方案1】:

    JSDoc 类型表达式的冲突示例涉及 JavaScript 原始类型 stringnumberboolean,它们具有相应的包装器类型:StringNumberBoolean

    来自Closure: The Definitive Guide

    Closure Library 中禁止使用包装器类型,因为 如果使用包装器类型,某些函数可能无法正常运行 需要原始类型的地方。

    参见 MDN:Distinction between string primitives and String objects

    【讨论】:

    • 在大多数情况下,您需要原始类型而不是 Object 类型。编译器会在必要时自动装箱(提升)原始类型,但反之则不然。
    • 感谢 cpeisert!我一定要拿到那本书!
    • 绝对可以。这是一本很棒的书,不仅仅是因为它的关闭信息!
    • “功能”呢?
    猜你喜欢
    • 2020-05-26
    • 2023-04-09
    • 2015-06-02
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-12-06
    • 2015-01-08
    • 2015-08-08
    相关资源
    最近更新 更多