Jsdoc3 评论对象答案

【问题标题】：Jsdoc3 commenting objectJsdoc3 评论对象
【发布时间】：2014-03-13 23:45:32
【问题描述】：

假设我有一些对象，使用 jsdoc3 评论它的方法是什么？

/**
 * Test object
 * @namespace test
 */
var test = {
    /**
     * Some defaults
     * @memberOf test
     */
    defaults: {
      'test1': 1,
      'test2': 2
    },
    /**
     * Somthing else
     * @memberOf test
     */
    deep: {
      /**
       * Some option
       * @memberOf {test.deep}
       */
      option: {},
      /**
       * Some method
       * @memberOf test.deep
       */
      method: {},
      /**
       * Some option
       * @memberOf {test.deep.evenMore}
       */
      evenMore: {
        /**
         * Some option
         * @memberOf test.deep.evenMore
         */
        test: false
      }
    }
};

但是 jsdoc 只为命名空间创建文档：测试和成员深度，默认值

命名空间：test test 测试对象

成员

深其他的

默认值一些默认值

【问题讨论】：

我相信 test.deep 也应该是一个命名空间，如果你想让成员出现的话。
我不是 javascript 方面的专家，但也许存在更好的方法来做这样的事情，也许是原型？

标签： javascript documentation comments jsdoc3

【解决方案1】：

正如@Scottux 所说，实现这一点的唯一方法是命名额外的命名空间。

/**
 * Test object
 * @namespace test
 */
var test = {
    /**
     * Some defaults
     * @memberOf test
     */
    defaults: {
      'test1': 1,
      'test2': 2
    },
    /**
     * Somthing else
     * @memberOf test
     * @namespace test.deep
     */
    deep: {
      /**
       * Some option
       * @memberOf test.deep
       */
      option: {},
      /**
       * Some method
       * @memberOf test.deep
       */
      method: {},
      /**
       * Some option
       * @memberOf test.deep
       * @namespace test.deep.evenMore
       */
      evenMore: {
        /**
         * Some option
         * @memberOf test.deep.evenMore
         */
        test: false
      }
    }
};

生成的文档将如下所示：

【讨论】：