// 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 维基页面:
参数与属性
如果期望参数具有特定属性，您可以在该参数的 @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);
}
曾经有一个 @config 标签紧跟在相应的 @param 后面，但它似乎已被弃用（例子在这里).
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
