Wie kann ich Jsdoc meinen Parameter als jquery Objekt markieren?

Question

Ich versuche mein Javascript gründlich zu kommentieren und verwende JSDoc. Ich habe eine Funktion, die ein jquery-Objekt verbraucht, und ich möchte den Parameter als solche markieren.

Zur Zeit habe ich dies:

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

Aber JSDoc nicht erkennt (oder richtig Format) JQuery als Variablentyp. Irgendeine Hilfe?

Answer 1

Nach http://code.google.com/p/jsdoc-toolkit/wiki/TagParam sollte es

Param-Typ vor param name sein.

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