【问题标题】:Multiple Optional Parameters JSDoc多个可选参数 JSDoc
【发布时间】:2014-11-10 19:27:55
【问题描述】:

我在js中有一个函数,签名如下:

  function foo(name, opt_callback, opt_dataStr);

我正在尝试使用 JSDoc for Closure 编译器对此进行注释,如下所示:

 /**
  * @param {string} name
  * @param {function(*)=} opt_callback
  * @param {string=} opt_dataStr
  */

但是每次 opt_callback 没有传入而 opt_dataStr 传入时,编译器都会生成十几个类型警告,抱怨我正在传递一个应该有函数的字符串。 我确信有一个简单的解决方案来正确注释它,但我已经尝试过

 * @param {function(*)=|string=} opt_callback

和

 * @param {(function(*)|string)=} opt_callback

以此类推,无济于事。谁能指出我正确的方向?

【问题讨论】:

    标签: google-closure-compiler optional-parameters jsdoc


    【解决方案1】:

    最后的作品,这编译没有警告:

    /**
      * @param {string} name
      * @param {(function(*)|string)=} opt_callback
      * @param {string=} opt_dataStr
      */
    function fn(name, opt_callback, opt_dataStr) {}
    
    fn('a','b');
    

    Here is an example

    【讨论】:

      猜你喜欢
      • 2013-08-25
      • 2017-09-02
      • 2023-03-08
      • 2015-02-25
      • 1970-01-01
      • 1970-01-01
      • 2011-08-17
      • 2021-11-02
      • 2021-11-16
      相关资源
      最近更新 更多