2012-11-28 2 views
18

철저하게 내 javascript에 주석을 달려고 시도하고 있으며 JSDoc을 사용하고 있습니다. jquery 객체를 사용하는 함수가 있는데이 매개 변수를 그러한 것으로 표시하고 싶습니다. jsdoc에서 jquery 객체로 내 param을 표시하도록하려면 어떻게해야합니까?

현재 나는이 있습니다

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

을하지만 JSDoc 변수 유형으로 JQuery와 (또는 제대로 형식)를 인식하지 못합니다. 어떤 도움이 필요합니까?

답변

22

http://code.google.com/p/jsdoc-toolkit/wiki/TagParam에 따르면,이 매개 변수 이름 앞에

파람 유형이어야합니다.

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

그랬습니다. 나는 그것이 단순해야만한다고 생각했다. .. 고마워! –

+14

그리고 일반적으로 (적어도 본 코드에서) 타입은 내 보낸 전역 변수의 이름과 일치하는'jQuery'입니다. –

+2

규약에 따라, JQuery 객체를'$'접두어로 사용하는 것이 유용합니다. 그런 식으로 모든 사람들은'$ formEl'이 엘리먼트에 대한 JQuery 참조라는 것을 압니다. –

관련 문제