[英]Jsdoc3 commenting object
Assuming I have some object, what the is way to comment it using jsdoc3? 假设我有一些对象,使用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
}
}
};
But jsdoc creates documentation only for Namespace: test and members deep, defaults 但是jsdoc仅为命名空间创建文档:测试和成员较深,默认
Namespace: test test Test object 命名空间:测试测试测试对象
Members 会员
deep Somthing else 深深的别的东西
defaults Some defaults 默认值一些默认值
As @Scottux said, the only way to archieve this is naming additional namespaces. 就像@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
}
}
};
The generated documentation will look like this: 生成的文档将如下所示:
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.