在Netbeans中使用JSDoc来完成对象的代码

时间:2014-01-13 17:25:36

标签: netbeans documentation jsdoc

我正在尝试让Netbeans在对象上提供一些代码完成。这是没有JSdoc的基本代码:

; var docTest = ( function( $, MyGlobal ){
  console.log( MyGlobal.foo );
} )( jQuery, SOME_GLOBAL_OBJECT );

SOME_GLOBAL_OBJECT在别处定义,基本上是一个看起来像这样的配置对象:

var SOME_GLOBAL_OBJECT = { foo: "bar", baz: "blech" };

我希望当我输入MyGlobal.

时强制Netbeans自动建议“foo”和“baz”

我尝试了一些事情,例如:

/**
* @typedef Global - My global options
* @type {object}
* @property {string} foo - Some foo
* @property {string} baz - Blech!
/*

其次是

/**
* @param {jQuery} $
* @param {Global} MyGlobal
*/
function ( $, MyGlobal ){ // ....

我也试过

/**
* @param {jQuery} $
* @param {{ foo: string, baz: string }} MyGlobal
*/

function ( $, MyGlobal ){ //....

甚至

/** @type {{ foo: string, baz: string }} MyGlobal */

但没有快乐。 Netbeans 7.4是否支持这类功能?记录我的对象的正确方法是什么,以便Netbeans知道它的属性?

0 个答案:

没有答案