2012-11-28 18 views
18

Javascript'imi iyice yorumlamaya çalışıyorum ve JSDoc kullanıyorum. Bir jquery nesnesini tüketen bir işlev var ve bu parametreyi işaretlemek istiyorum. Paramimi jquery nesnesi olarak işaretlemek için jsdoc'u nasıl edinebilirim?

Şu anda bu var:

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

Ama JSDoc değişken türü olarak JQuery (veya düzgün biçimi) tanımıyor. Herhangi bir yardım?

cevap

22

http://code.google.com/p/jsdoc-toolkit/wiki/TagParam göre, param name önce

Param türü olmalıdır. did it

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

. Basit bir şey olması gerektiğini düşündüm ... Teşekkürler! –

+14

Ve genellikle (en azından gördüğüm kodda) tür, dışa aktarılan global değişkenin adını eşleştirmek için "jQuery" türüdür. –

+2

Bir kural olarak, JQuery nesnelerini '$' önekine eklemek yararlı olur. Bu şekilde herkes bilir ki '$ formEl' öğeye JQuery referansıdır. –

İlgili konular