JSDoc中文文档(@use JSDoc)

JSDoc @property 标签

目录

同义词

JSDoc @prop 标签

概述

@property标签很容易描述类，命名空间或其它对象的静态属性列表。

通常JSDoc模板将创造一个全新的页面来显示关于命名空间嵌套的每一层级的信息。有时候，你真的想要在同一张页面上列出所有属性，包括嵌套的属性。

请注意，@property标记必须在命名空间或类的文档注释块中使用。该标签适用于静态属性的简单集合，它不允许你为每个属性提供@examples或类似的复杂信息，只包含类型，名称和说明。

示例

在这个例子中，我们有一个名为"config"的命名空间。我们想要所有有关默认属性及嵌套值的信息，输出到与"config"同一个页面上。

示例: 描述命名空间的默认属性及嵌套属性
/**
 * @namespace
 * @property {object}  defaults               - The default values for parties.
 * @property {number}  defaults.players       - The default number of players.
 * @property {string}  defaults.level         - The default level for the party.
 * @property {object}  defaults.treasure      - The default treasure.
 * @property {number}  defaults.treasure.gold - How much gold the party starts with.
 */
var config = {
    defaults: {
        players: 1,
        level:   'beginner',
        treasure: {
            gold: 0
        }
    }
};

下面的示例演示如何指示属性是可选的：

示例: 具有必需和可选属性的类型定义
/**
 * User type definition
 * @typedef {Object} User
 * @property {string} email
 * @property {string} [nickName]
 */