javascript - 记录类中的属性命名空间

标签 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 property?
         */
        first: forename,

        /**
         * How to document such a property?
         */
        second: surname
    };

}

更新:

使用 @namespace@property 确实有效,但它显示在 Namespaces 而不是 MembersProperties,并且仅作为将我带到单独页面的链接,这很尴尬,因为我只记录了一个类。更糟糕的是,这样的 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/

相关文章:

javascript - 如何将图像 (PNG) 转换为 2D 数组(二进制图像)?

javascript - 当我编辑 htaccess 时,CSS 和 JS 丢失了

javascript - 简单的 Javascript 书签问题

javascript - 将 HTML 文件加载到 Bootstrap Modal

javascript - 你如何称呼一个带有函数的对象

javascript - 如何记录调用另一个函数的函数的返回值

javascript - 如何用 JavaScript 写出 "array of pattern"?

javascript - Node.js 模块指南

angularjs - 带有 AngularJS 的 JSDoc

javascript - 如何在 JS Doc 中记录枚举值