18
我正在嘗試徹底評論我的JavaScript,我正在使用JSDoc。我有一個函數,它使用了一個jQuery對象,我想標記這個參數。如何讓jsdoc將我的參數標記爲jquery對象?
目前我有這樣的:
/**
* Initializes a login object.
* @param formEl {JQuery} The login form element on the page.
*/
var login = function(formEl){ ... }
但JSDoc不承認(或適當的格式)的JQuery作爲變量類型。任何幫助?
這樣做。我認爲它必須是簡單的東西......謝謝! –
通常(至少在我見過的代碼中)類型是「jQuery」,以匹配導出的全局變量的名稱。 –
作爲慣例,使用'$'前綴JQuery對象是有幫助的。這樣每個人都知道'$ formEl'是元素的JQuery引用。 –