node.js异步操作多,怎么写注释?

[rekey]

如题.
类似如下代码.返回的是一个Promise,如何明确的通过注释告知返回值?

/**
* 检测图片信息
* @param {String} imagePath 需要检测的图片路径
* @type {Object}
* @returns {Object} 通过Promise对象返回图片相关信息
*/
function identify(imagePath) {
var deferred = when.defer();
imagemagick.identify(imagePath, function (err, data) {
if (err) {
deferred.reject({
'errno' : 3,
'message' : 'file is not a image.'
});
} else {
var channel_statistics = data['channel statistics'];
deferred.resolve({
size : data.filesize,
width : data.width,
height : data.height,
type : mimeTypes[data.format],
mean : [channel_statistics.red.mean.replace(/\.[\d]+ \(.*\)/, ''), channel_statistics.green.mean.replace(/\.[\d]+ \(.*\)/, ''), channel_statistics.blue.mean.replace(/\.[\d]+ \(.*\)/, '')]
});
}
});
return deferred.promise;
}

[tamamaxox]

when.js

[tamamaxox]

哦..不就备注了resolve吗

[rekey]

@tamamaxox 好吧,突然想通了.如果代码过长而看不到resolve应该也是不科学的.

刚刚YUIDoc和jsdoc都试了试.貌似@example都会导致注释太长.

纠结啊.

[XadillaX]

用async吧

[acecode]

异步操作最好用个异步库整理下，async, Q 啊神马的

[rekey]

@XadillaX 嗯,这些都有做.我现在只是想探讨怎么写注释.

[rekey]

@acecode var deferred = when.defer(); 代码大概第二行就是这个,您是不是偶尔也需要多了解异步处理的方式?