【问题标题】:yuidoc - how to define a class method in an other fileyuidoc - 如何在其他文件中定义类方法
【发布时间】:2013-04-05 12:21:47
【问题描述】:

我正在使用 yuidoc 编写文档。但是,我有一个模型类,它在别处定义了它的一个方法。这是一些可视化情况的代码。 假设我有一个文件 model.js:

/**
 * @class Model
 * @constructor
 */
 window.Model = function(){}
 ....

还有一个文件activerecord.js:

(function(){
    /**
     * @class ActiveRecord
     * @constructor
     window.ActiveRecord = function(){}
     ....
     /**
      * @method Model.hasMany
      * @param {Class} model
      */
     function hasMany(model) {}
})() ;

如您所见,“hasMany”方法应该出现在 Model 的类文档下。然而,事实并非如此。这样的事情可能吗?

非常感谢

【问题讨论】:

    标签: javascript documentation yuidoc


    【解决方案1】:

    查看@for 标签:http://yui.github.io/yuidoc/syntax/index.html#for

    /**  
     * Some method "hasMany" disconnected from its class "Model".
     * 
     * @method hasMany  
     * @for Model
     * @param {Class} model 
     */
    function hasMany(model) {}
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2021-02-03
      • 2019-03-05
      • 2013-01-18
      • 1970-01-01
      • 2013-03-17
      相关资源
      最近更新 更多