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

标签 jsdoc jsdoc3

/**
 * @param {String} foo
 * @param {Number} bar
 */
或者
/**
 * @param {string} foo
 * @param {number} bar
 */
JSDoc @type 文档没有明确说明它。
我总是大写 StringNumber因为我的理解是我需要使用构造函数名称。在 JavaScript 中, String Number 作为构造函数存在。
我注意到不一致:我将其他原始类型(例如 nullundefined )定义为小写。
原始类型名称需要大写还是小写?

最佳答案

It doesn't matter :

JSDoc doesn't care. It's up to the user's preference. I tend to use lowercase for primitive types (and function, for some reason) and uppercase for Array and Object.



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

关于jsdoc - 原始类型名称需要大写还是小写?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32846527/

相关文章:

javascript - JSDoc 3 如何读取带有#include 的.c 或.h 文件? (#为非法字符)

javascript - 如何在自调用函数中记录简单类?

webstorm - JSDoc 仅描述对象值

node.js - 没有 Java 的 JSDoc?

javascript - 设置接口(interface)方法时,在 VSCode 中出现智能感知错误

javascript - 如何使用 JSdoc 引用另一个文件中的@class?

javascript - 如何记录具有多个别名的方法?

node.js - 来自node.js的@type for "exported modules"和良好的文档描述?

javascript - jsdoc:如何使用括号表示法记录属性?

javascript - 为什么 VS Code 显示 JSDoc 中 var 的类型信息,而不显示 JavaScript 中其他成员的类型信息?