描述使用 Object.defineProperty 定义的属性

Describe property defined with Object.defineProperty

本文关键字：定义 属性 defineProperty Object 描述      更新时间：2023-09-26

我想为添加为Object.defineProperty的属性添加 JSDoc 文档。我想这样的事情可能会起作用：

/** @constructor */                                                         
function MyClass() {                                                        
  /** @property {Number} rnd */                                             
  Object.defineProperty(this, 'rnd', {                                      
    get : function () { return Math.random(); }                             
  });                                                                       
}

但是生成的 JSDoc 解释没有此属性：

$ jsdoc -X test.js
[
    {
        "comment": "/** @constructor */",
        "meta": {
            "range": [ 20, 167 ],
            "filename": "test.js",
            "lineno": 2,
            "path": "/jsdoctest",
            "code": {
                "id": "astnode100000001",
                "name": "MyClass",
                "type": "FunctionDeclaration",
                "paramnames": []
            },
            "vars": { "": null }
        },
        "kind": "class",
        "name": "MyClass",
        "longname": "MyClass",
        "scope": "global"
    },
    {
        "comment": "",
        "meta": {
            "range": [ 116, 159 ],
            "filename": "test.js",
            "lineno": 5,
            "path": "/jsdoctest",
            "code": {
                "id": "astnode100000012",
                "name": "get",
                "type": "FunctionExpression",
                "value": "function"
            }
        },
        "undocumented": true,
        "name": "get",
        "longname": "get",
        "kind": "function",
        "scope": "global"
    },
    {
        "kind": "package",
        "longname": "package:undefined",
        "files": [ "/jsdoctest/test.js" ]
    }
]

记录此类属性的最合适方法是什么？（也许是插件？

这样做：

/** @constructor */
function MyClass() {
  /**
   * @property {Number}
   * @name MyClass#rnd
   */
  Object.defineProperty(this, 'rnd', {
    get : function () { return Math.random(); }
  });
}

我使用过@property {type} name语法，但从未在类中使用过。我通常做的是这样的：

/** @property {object} */
this.foo = {};

然后jsdoc使用this.foo来计算名称（foo）以及它属于哪个实体。似乎在类中使用@property {type} name不起作用。

如果使用 @name 指定名称，则它知道要为其指定的名称以及它所属的位置。#表示它是一个实例变量（而不是静态或内部变量）。有关详细信息，请参阅名称路径文档。

如果要在类外部声明成员，可以使用：

/**
 * @constructor
 */
function MyClass() {};
/**
 * Get the number of differed values in this map
 *
 * @member {number} count
 * @memberOf module:moduleName.MyClass#
 * @readonly
 */
Object.defineProperty(MyClass.prototype, 'rnd', {
  get : function () { return Math.random(); }
});
相关文章：