我在使用jQuery-1.4.3 externs文件时特别注意到了这一点。该文件的javadoc如下:
/**
* @param {(string|number|function(number,number))=} arg1
* @return {(number|jQueryObject)}
* @nosideeffects
*/
jQueryObject.prototype.width = function(arg1) {};
我有一个这样的调用:
var w = $(window).width();
$('#whatever').width(w)
Closure 报错:
警告 - jQueryObject.prototype.height 的实际参数1与形式参数不符
找到的内容:(jQueryObject|null|number)
所需内容:(function (number, number): ?|number|string|undefined)
$('#Xobni').height($(window).height());经过尝试(删除可能的返回类型),我发现问题在于第一次调用 width 可能会返回一个 jQueryObject ,而这不是有效的输入,因此 Closure 给出了错误。我尝试添加以下代码:
/**
* @type {number}
*/
var w = $(window).width();
$('#Xobni').width(w);
但是Closure抱怨:
警告 - 初始化变量
找到:(jQueryObject|null|number)
需要:number
var w = $(window).width();
问题在于当width带有参数时,它返回的是一个jQuery对象。 当它没有带参数时,它返回的是一个数字。 所以我知道我的调用没问题,但javadoc并没有完全反映这一点,所以Closure会发出警告。 有没有一种方法可以适当修复javadoc或者告诉Closure我知道这个结果将是一个数字。 我知道我可以抑制错误,但我想知道如何更好地注释这些内容。
感谢你的帮助!