web-dev-qa-db-ja.com

JSDocにパラメータをjQueryオブジェクトとしてマークさせるにはどうすればよいですか?

JavaScriptに徹底的にコメントしようとしていますが、JSDocを使用しています。 jQueryオブジェクトを使用する関数があり、パラメーターをそのようにマークしたいと思います。

現在、私はこれを持っています:

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

しかし、JSDocは「JQuery」を変数型として認識(または適切にフォーマット)しません。何か助けはありますか?

30
Nick G.

http://code.google.com/p/jsdoc-toolkit/wiki/TagParam によると

パラメータ名の前のパラメータタイプ。

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