Javascript 在类中记录属性命名空间
如何在类中记录属性命名空间Javascript 在类中记录属性命名空间,javascript,jsdoc,Javascript,Jsdoc,如何在类中记录属性命名空间 /** * @constructor User * @param forename * @param surname */ function User(forename, surname) { /** * How to document such a property-namespace? */ this.name = { /** * How to document such a prop
/**
* @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
下,而不是成员
或属性
,并且仅作为链接将我带到单独的页面,这很尴尬,因为我只记录了一个类。更糟糕的是,这样的名称空间也出现在全局名称空间列表中。这似乎是个糟糕的解决方案。有更好的吗?这种方法有效:
/**
* @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 您不能使用
@命名空间
、@成员
和@属性
?这就是我在谷歌搜索时得到的结果。@mostruash那么所包含的属性呢?@mostruash确实有效,但会将我带到一个单独的名称空间文档页面,这很尴尬,因为它是我正在记录的同一个类。jsdoc在其@property
文档中记录了这种行为。我想你可以用@member
@mostruash替换@namespace
。@member
和@property
的组合确实很好!您可以将其作为答案发布;)