javascript - 如何使用 ngdoc 记录一个以 Angular 返回类的工厂？

Question

给定一个带有返回类的工厂的 Angular 应用程序，如下所示:

angular.module('fooApp').factory('User', function(){
    function User(name){
        this.name = name;
    }

    User.prototype.greet = function(){
        return "Howdy, " + this.name;
    }

    return User;
});

使用 ngdoc(jsdoc Angular 使用的特殊风格)，如何在不将其定义为方法的情况下记录初始化程序？

现在，这是我尝试过的:

/**
 * @ngdoc service
 * @name fooApp.User
 * @description User factory.
 */

angular.module('fooApp').factory('User', function(){

    /**
     * @ngdoc method
     * @methodOf fooApp.User
     * @name Initializer
     * @description Initializes a new User object with a name
     */
    function User(name){
        this.name = name;
    }

    User.prototype.greet = function(){
        return "Howdy, " + this.name;
    }

    return User;
});

但这会导致 User 初始化器(接受参数 name 的 User 函数)被视为名称为 Initializer，这会让尝试使用此代码的人感到困惑。

我已经尝试添加 @constructor 标志，但这对 html dgeni 最终生成 没有任何影响。

谢谢。

---

更新:删除了对 dgeni 的引用。我的印象是我使用的插件 ( grunt-ngdocs ) 在幕后使用了 dgeni，但事实并非如此。

Answer 1

这就是我在没有任何 Angular 经验的情况下的做法:

/**
 * @ngdoc service
 * @name fooApp.User
 * @description User factory.
 */

angular.module('fooApp').factory('User', function(){

    /**
     * @ngdoc method
     * @constructs fooApp.User
     * @description Initializes a new User object with a name
     */
    function User(name){
        this.name = name;
    }

    User.prototype.greet = function(){
        return "Howdy, " + this.name;
    }

    return User;
});