Làm thế nào tôi có thể nhận được jsdoc để đánh dấu param của tôi như là một đối tượng jquery?

Question

Tôi đang cố gắng nhận xét kỹ javascript của mình và tôi đang sử dụng JSDoc. Tôi có một chức năng tiêu thụ một đối tượng jquery và tôi muốn đánh dấu tham số như vậy.

Hiện nay tôi có điều này:

/** 
* Initializes a login object. 
* @param formEl {JQuery} The login form element on the page. 
*/ 
var login = function(formEl){ ... } 

Nhưng JSDoc không nhận ra (định dạng hoặc đúng) JQuery như một loại biến. Bất kỳ giúp đỡ?

Answer 1

Theo http://code.google.com/p/jsdoc-toolkit/wiki/TagParam phải là

Loại thông số trước tên param.

/** 
* Initializes a login object. 
* @param {jQuery} formEl The login form element on the page. 
*/ 
var formEl = jQuery('form');