Question

示例代码：

/**
 * @module mymodule
 */

/**
 * my namespace
 * @namespace
 */
var MYMODULE = function() {
    var that = {};

    var MyClass;

    /**
     * @class
     */
    MyClass = function() {
        var that = {};

        var myClassMethod;

        /**
         * what to put here?
         */
        myClassMethod = function() {
        };
        that.myClassMethod = myClassMethod;

        return that;
    };
    that.MyClass = MyClass;

    return that;
}();

我希望myClassMethod（）的文档出现在JSDoc为类MyClass生成的HTML页面上。我该怎么办？

Answer 1

您已将@module定义为mymodule，这时定义应从module:mymodule...开始，以出现在HTML文档中的模块下。以下是示例...

/**
 * @module mymodule
 */
 var mymodule= mymodule|| {};
 /**
  * my namespace
  * @namespace module:mymodule.MYMODULE
  */
 var MYMODULE = function() {
     /**
      * @class
      * @memberof module:mymodule.MYMODULE
      */
     MyClass = function() {
         /**
          * what to put here?
          * @memberof module:mymodule.MYMODULE.MyClass
          */
         myClassMethod = function() {
         }
     }
 }

请注意，如果您不想在注解中重新定义名称，那么在没有@memberof注解的情况下，所有内容都可以正常工作。我们将上面的方法与@memberof结合使用，并将@alias与# Fonction qui récupère la valeur du champs booléen inscription de l'année précédente @api.depends('half_pension') def _retrieve_halfpension_previous(self): records = self.env['ecole.partner.school'].search([]) for record in records: record.half_pension_previous = record.half_pension结合使用，以很好地控制我们想要在结果文档中显示的内容。

如何告诉JSDoc某个函数是功能上定义的类的方法？

1 个答案: