如何记录多维对象？答案

【问题标题】：how can I document multidimensional object?如何记录多维对象？
【发布时间】：2016-05-26 19:00:27
【问题描述】：

我正在使用http://documentation.js.org/ 的 gulp 插件，它会生成整个索引文件，以便阅读我的项目的文档。

我的问题是，假设我有一个像这样的对象：

/**
 * a
 * @namespace
 */

var a = {

    /**
     * b
     * @namespace a.b
     */

    b : {

        /**
         * c
         * @namespace a.b.c
         */

        c : function() {

        }
    }
};

我希望看到侧边栏会有一个多缩进列表，而不是像这样显示项目：

A
    B
        C

这样显示它们：

A
    B
C

这可能吗？

【问题讨论】：

标签： object documentation gulp jsdoc

【解决方案1】：

如果我理解正确，您可能对嵌套对象文档感兴趣：

http://usejsdoc.org/tags-property.html

【讨论】：

【解决方案2】：

使用 memberof 指令，您可以轻松指定子模块/标签之间的命名空间和链接

/**
 * @name a
 * @module
 */

var a = {

    /**
     * @name b
     * @memberof a
     * @module
     */

    b : {

        /**
         * @name c
         * @memberof b
         */

        c : function() {

        }
    }
};

【讨论】：