@property

Содержание

• Синонимы
• Обзор
• Примеры
• Связанные ссылки

Синонимы

@prop

Обзор

Тег @property — способ легко документировать список статических свойств класса, пространства имен или другого объекта.

Обычно шаблоны JSDoc создают целую новую страницу для отображения информации о каждом уровне вложенной иерархии пространства имен. Иногда вам нужно просто перечислить все свойства, включая вложенные, вместе на одной странице.

Обратите внимание, что теги свойств должны использоваться в комментариях документации для объекта, свойствами которого они являются, например, для пространства имен или класса. Этот тег предназначен для простых коллекций статических свойств; он не позволяет вам предоставлять @примеры или другую сложную информацию для каждого свойства, только тип, имя и описание.

Примеры

В этом примере у нас есть пространство имен с именем «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]
 */

Связанные ссылки

• @enum
• @member