如何记录类中的属性命名空间?
/**
* @constructor User
* @param forename
* @param surname
*/
function User(forename, surname) {
/**
* How to document such a property-namespace?
*/
this.name = {
/**
* How to document such a property?
*/
first: forename,
/**
* How to document such a property?
*/
second: surname
};
}
更新:
使用 @namespace
和 @property
确实有效,但它显示在 Namespaces
而不是 Members
或Properties
,并且仅作为将我带到单独页面的链接,这很尴尬,因为我只记录了一个类。更糟糕的是,这样的 namespace 也出现在全局 namespace 列表中。似乎是一个糟糕的解决方案。还有更好的吗?
最佳答案
这个有效:
/**
* @constructor User
* @param forename
* @param surname
*/
function User(forename, surname) {
/**
* @member {Object} User.name
*
* @property {String} forename
*
* @property {String} surname
*/
this.name = {
forename: forename,
surname: surname
};
}
谢谢@mostruash!
关于javascript - 记录类中的属性命名空间,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/34964976/