|
Boolean
|
{boolean} name
|
true/false
|
|
Integer
|
{number} name
|
0
|
|
Float
|
{number} name
|
0.0
|
|
Object
|
{Object} name
|
|
|
SpecifiedObject
|
{CustomName} name
|
see @typedef
|
|
Array
|
{Array} name
|
[]
|
|
Array of Types
|
{Type[]} name
|
{string[]}
|
|
String
|
{string} name
|
'test'
|
|
Optional string
|
{string} [name]
|
|
|
Optional string default value
|
{string} [name=test]
|
|
|
@param {type} name
|
Defines a parameter
|
|
@constructor
|
Defines a constructor
|
|
@deprecated
|
Function is deprecated
|
|
@return {type}
|
Defines return type
|
/**
* @typedef ObjectOne
* @type {Object}
* @property {number} id
* @property {string} name
*/ /**
* @param {string} one
* @param {number} two
*/
function x( one, two ) {} /**
* @param {string[]} ones
*/
function x( ones ) {} /**
* @param {string} one
* @param {number} [two]
*/
function x( one, two ) {
two = two || 0;
} /**
* @param {string} one
* @param {number} [two=121]
*/
function x( one, two ) {
two = two || 121;
} /**
* @param {string|string[]} one
*/
function x( one, two ) {} /**
* @param {ObjectOne} one
*
* @typedef ObjectOne
* @type {Object}
* @property {number} id
* @property {string} name
*/
function x( one ) {
one.id;
one.name;
}No comments yet.
Cheatography n. The art of mapping complex subjects into clear, instantly navigable reference guides.