@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]
*/