首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >JSDoc3 -如何记录类的子成员

JSDoc3 -如何记录类的子成员
EN

Stack Overflow用户
提问于 2014-02-26 23:20:57
回答 1查看 137关注 0票数 0

我试图编写类似于以下内容的文档,其中baz1bazzed是包含在bar中的属性,barFoo的成员

代码语言:javascript
复制
/**
 * @class
 */
function Foo(){
  this.bar = {
     /**
      * The baz function
      */
     baz1: function(){},
     /**
      * The baz1 function
      */
     bazzed: 'bazzed'
  }
}

var foo = new Foo();

//call baz and baz1
foo.bar.baz();
foo.bar.baz1;

现在,JSDoc记录了Foobar,但是它忽略了baz1bazzed

我意识到我可以做这样的事

代码语言:javascript
复制
/**
 * @class
 */
function Foo(){
  /**
   * @property {function} baz - Does baz
   * @proprety {string} baz1 - Stores baz1
   */
  this.bar = {
     /**
      * The baz function
      */
     baz1: function(){},
     /**
      * The baz1 function
      */
     bazzed: 'bazzed'
  }
}

但我不愿这样做,原因有三:

  1. 有些类通过baz2:function(){}实现了baz10:function(){}
  2. 一些baz有很大的评论块,在bar的评论块中包含似乎是没有意义的。
  3. 在一些地方,代码有foo.bar.baz.buzz(),它只混合了1和2的原因。

我知道这是个很长的问题,但我在过去的4个小时里一直在寻找空的答案。

EN

回答 1

Stack Overflow用户

发布于 2014-03-26 17:24:30

把酒吧列为Foo的子类怎么样?

代码语言:javascript
复制
/**
 * @class
 */
function Foo(){
    /**
     * @class
     * @type {{baz1: baz1, bazzed: string}}
     */
    this.bar = {
        /**
         * The baz function
         */
        baz1: function(){},
        /**
         * The baz1 function
         */
        bazzed: 'bazzed'
    }
}
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/22055705

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档