node.js异步操作多,怎么写注释? - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
rekey
V2EX    Node.js

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

  •  
  •   rekey 2014-01-11 15:38:08 +08:00 8126 次点击
    这是一个创建于 4294 天前的主题,其中的信息可能已经有所发展或是发生改变。
    如题.
    类似如下代码.返回的是一个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;
    }
    7 条回复    1970-01-01 08:00:00 +08:00
    tamamaxox
        1
    tamamaxox  
       2014-01-11 22:31:29 +08:00 via Android
    when.js
    tamamaxox
        2
    tamamaxox  
       2014-01-11 22:35:33 +08:00 via Android
    哦..不就备注了resolve吗
    rekey
        3
    rekey  
    OP
       2014-01-11 22:42:00 +08:00
    @tamamaxox 好吧,突然想通了.如果代码过长而看不到resolve应该也是不科学的.

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

    纠结啊.
    XadillaX
        4
    XadillaX  
       2014-01-13 14:03:38 +08:00
    用async吧
    acecode
        5
    acecode  
       2014-01-13 16:47:31 +08:00
    异步操作最好用个异步库整理下,async, Q 啊神马的
    rekey
        6
    rekey  
    OP
       2014-01-14 11:35:01 +08:00
    @XadillaX 嗯,这些都有做.我现在只是想探讨怎么写注释.
    rekey
        7
    rekey  
    OP
       2014-01-14 11:35:45 +08:00
    @acecode var deferred = when.defer(); 代码大概第二行就是这个,您是不是偶尔也需要多了解异步处理的方式?
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     5210 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 25ms UTC 09:31 PVG 17:31 LAX 02:31 JFK 05:31
    Do have faith in what you're doing.
    ubao snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86