2009-08-04 83 views
1

我一直在试图使用JsDoc来记录我的JavaScript,但我不断遇到这个障碍。在上面,我使用的命名空间使用JSDoc与命名空间和函数定义的变体形式

/** 
* Container for all editing methods 
* @namespace 
*/ 
var FREdit = { 

    /** 
    * Toggle value for editing 
    * @type Number 
    */ 
    isToggleOn:0, 

    /** 
    * Initialize editing 
    */ 
    init: function(){ 
     this.initPopups(); 
    }, 

    /** 
    * Function to enable editing 
    */ 
    enable: function(){ 
     this.enableTitles(); 
      this.isToggleOn = 1; 
    } 
}; 

:口口声声说“没什么记录,退出”

这里是代码我想文档peice的。即使我在JavaScript中使用函数定义的变体形式,JSDoc似乎也无法识别它。例如:

/** 
* Just any function 
*/ 
var any_function = function(){ 

}; 

任何想法如何解决这个问题?谢谢!

回答

1

从你的问题判断我猜你正在使用JSDoc。 原来的JSDoc已经暂时不受支持了。

我建议你使用jsdoc-toolkit,因为它有更好的支持。根据他们的文件,你可以document the class pattern。 看看他们的例子,你应该很好去!

干杯!

+0

谢谢!发布后,我发现jsdoc-toolkit,它工作得很好! – Ankit 2009-08-07 06:56:35