-
-
Notifications
You must be signed in to change notification settings - Fork 36k
Closed
Labels
Milestone
Description
Description
I just want to highlight some minor things that are showing up as errors with my IDE (JetBrains Rider) with the new JSDoc annotations.
Primitive types shouldn't be capitalized:
{String}
should be{string}
{Boolean}
should be{boolean}
{Number}
should be{number}
{Any}
should be{any}
The question mark ?
to denote a nullable type should come before the type, not after.
For example: {MyType?}
should be {?MyType}
(see https://jsdoc.app/tags-type)
Example of invalid JSDoc syntax in src/nodes/core/Node.js:
three.js/src/nodes/core/Node.js
Lines 101 to 108 in 8540d9f
/** | |
* The cache key of this node. | |
* | |
* @private | |
* @type {Number?} | |
* @default null | |
*/ | |
this._cacheKey = null; |
Screenshot of IDE error (JetBrains Rider):
Version
173
Mugen87mrdoob