【问题标题】:Do primitive type names need to be uppercase or lowercase?原始类型名称需要大写还是小写?
【发布时间】:2015-12-27 02:01:36
【问题描述】:
/**
 * @param {String} foo
 * @param {Number} bar
 */

/**
 * @param {string} foo
 * @param {number} bar
 */

JSDoc @type 文档没有明确说明。

我总是将StringNumber 大写,因为我的理解是我需要使用构造函数名称。在 JavaScript 中,StringNumber 作为构造函数存在。

我注意到不一致:我将其他基本类型(例如nullundefined)定义为小写。

原始类型名称需要大写还是小写?

【问题讨论】:

    标签: jsdoc jsdoc3


    【解决方案1】:

    It doesn't matter:

    JSDoc 不在乎。这取决于用户的偏好。我倾向于对原始类型(和函数,出于某种原因)使用小写字母,对 Array 和 Object 使用大写字母。

    我倾向于使用小写,因为typeof 运算符返回小写。

    【讨论】:

    • 我创建了一个 ESLint 插件,它强制执行一致的类型大小写(除其他外),github.com/gajus/eslint-plugin-jsdoc
    • the linked issue 的作者在这里。如果您查看有多少其他项目与该问题相关联,这表明开发人员正在寻求指导。说“JSDoc 不关心”会忽略这种寻求指导的过程。
    猜你喜欢
    • 2015-02-09
    • 2016-11-24
    • 1970-01-01
    • 1970-01-01
    • 2019-08-03
    • 2010-10-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多