JSDOC用于Javascript闭包或匿名函数中的类

时间:2014-03-11 01:52:39

标签: function anonymous jsdoc

我想在我的AngularJS代码中添加jsdoc注释,所以我尝试了:

PageFactory.js

/**
 * Creates an instance of PageFactory.
 *
 * @constructor
 * @this {PageFactory}
 * 
*/
function PageFactory() {
}

angular.module ( 'app' ).factory ('PageFactory', PageFactory);

以上工作正常并产生预期的jsdoc输出。但是,当我将这些代码包含在这样的匿名函数中时:

PageFactory.js

(function (){

    /**
     * Creates an instance of PageFactory.
     *
     * @constructor
     * @this {PageFactory}
     * 
    */
    function PageFactory() {
    }

    angular.module ( 'app' ).factory ('PageFactory', PageFactory);

})();

生成的jsdoc html输出为空白,没有关于PageFactory类的文档。

是否可以使jsdoc与匿名函数一起使用或使用我的第二个代码?

提前致谢。

1 个答案:

答案 0 :(得分:1)

像这样使用@lends <global>

(/** @lends <global> */ function (){
// etc... the rest remains the same.