我正在使用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
这可能吗?
答案 0 :(得分:0)
如果我理解正确,您可能对嵌套对象文档感兴趣:
答案 1 :(得分:0)
使用memberof指令,您可以轻松指定子模块/标记之间的名称空间和链接
/**
* @name a
* @module
*/
var a = {
/**
* @name b
* @memberof a
* @module
*/
b : {
/**
* @name c
* @memberof b
*/
c : function() {
}
}
};