@use JSDoc

同義詞

概觀

@property 標籤是一種輕鬆記錄類別、命名空間或其他物件的靜態屬性清單的方式。

通常 JSDoc 範本會建立一個全新的頁面，以顯示有關巢狀命名空間層級中每個層級的資訊。有時您真正想要做的是將所有屬性（包括巢狀屬性）全部列在同一個頁面上。

請注意，屬性標籤必須用在文件註解中，例如命名空間或類別的屬性。此標籤適用於靜態屬性的簡單集合，不允許您為每個屬性提供 @examples 或類似的複雜資訊，僅提供類型、名稱和說明。

範例

在此範例中，我們有一個名為「config」的命名空間。我們希望有關 defaults 屬性的所有資訊（包括其巢狀值）與 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]
*/