JS Docs
Reference Links
Docs
Example
Overview
typedef
@typedef {string} name
@typedef {number} id
@typedef {Object} Marks
@property {string} subject
@property {number} marks
@typedef {Array<String>} subjects
param
(+ optional parameter and default value)
/**
* @param {string} name - Student's name
* @param {number} id - Unique identification number
* @param {Array<String>} subjects - subjects
* @param {Boolean} [paramOptionalDefault=false] - param optional with Default.
* @param {Boolean} [paramOptional] - param optional.
setProperties(name, id, subjects, paramOptionalDefault, paramOptional) {
}
*/
returns
/**
* @returns {Marks} - marks
*/
getMarks() {
}
/**
* @returns {string} name - Name
*/
getName() {
}
memberof
class StudentCls {
/**
* @memberof StudentCls
*/
getStudentMarks() {
}
}
Example
/**
*
*
* @class StudentCls
*/
class StudentCls {
/**
* @typedef {Object} Marks
* @property {string} subject
* @property {number} marks
*/
/**
*
*
* @param {Array<String>} subjects - subjects
* @returns {Marks} - marks
* @memberof StudentCls
*/
getStudentMarks(subjects) {
var retObj = {
subject: 'Maths',
marks: 95
}
return retObj;
}
}