如何解决如何在jsdoc中描述“对象”参数？
|// My function does X and Y.
// @params {object} parameters An object containing the parameters
// @params {function} callback The callback function
function(parameters,callback) {
}
{
setting1 : 123,// (required,integer)
setting2 : \'asdf\' // (optional,string)
}
解决方法
从@param Wiki页面：
具有属性的参数
如果期望某个参数具有特定的属性，则可以在该参数的@param标记后立即对其进行记录，如下所示：
/**
* @param userInfo Information about the user.
* @param userInfo.name The name of the user.
* @param userInfo.email The email of the user.
*/
function logIn(userInfo) {
doLogIn(userInfo.name,userInfo.email);
}
/**
* @param {{a: number,b: string,c}} myObj description
*/
@returns
/**
* @param {Object} myObj description
* @param {number} myObj.a description
* @param {string} myObj.b description
* @param {} myObj.c description
*/
@returns
@param
@returns
/**
* @typedef {Object} Person
* @property {string} name how the person is called
* @property {number} age how many years the person lived
*/
@param
/**
* @param {Person} p - Description of p
*/
@returns
/**
* @returns {Person} Description
*/
/**
* @param {Object.<string,number>} dict
*/
@returns
[]
/**
* @param {number} [opt_number] this number is optional
*/
/**
* @param {number|undefined} opt_number this number is optional
*/
{1: \'Pete\',2: \'Mary\',3: \'John\'}for(var key in obj){...}/**
* @return {Object.<number,string>}
*/
function getTmpObject() {
var result = {}
for (var i = 10; i >= 0; i--) {
result[i * 3] = \'someValue\' + i;
}
return result
}
{id: 1,title: \'Hello world\',type: \'LEARN\',children: {...}}object.id
/**
* Generate a point.
*
* @returns {Object} point - The point generated by the factory.
* @returns {number} point.x - The x coordinate.
* @returns {number} point.y - The y coordinate.
*/
var pointFactory = function (x,y) {
return {
x:x,y:y
}
}
/**
@class generatedPoint
@private
@type {Object}
@property {number} x The x coordinate.
@property {number} y The y coordinate.
*/
function generatedPoint(x,y:y
};
}
/**
* Generate a point.
*
* @returns {generatedPoint} The point generated by the factory.
*/
var pointFactory = function (x,y) {
return new generatedPoint(x,y);
}
/**
@typedef generatedPoint
@type {Object}
@property {number} x The x coordinate.
@property {number} y The y coordinate.
*/
/**
* Generate a point.
*
* @returns {generatedPoint} The point generated by the factory.
*/
var pointFactory = function (x,y:y
}
}
/**
* @return {{myNum: number,myObject}}
* An anonymous type with the given type members.
*/
function getTmpObject() {
return {
myNum: 2,myObject: 0 || undefined || {}
}
}
@return
{{field1: Number,field2: String}}@param
/** My function does X and Y.
@params {object} parameters An object containing the parameters
@config {integer} setting1 A required setting.
@config {string} [setting2] An optional setting.
@params {MyClass~FuncCallback} callback The callback function
*/
function(parameters,callback) {
// ...
};
/**
* This callback is displayed as part of the MyClass class.
* @callback MyClass~FuncCallback
* @param {number} responseCode
* @param {string} responseMessage
*/
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。