@public

Оглавление

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

Обзор

Тег @public указывает, что символ должен быть задокументирован как общедоступный.

По умолчанию JSDoc обрабатывает все символы как общедоступные, поэтому использование этого тега обычно не влияет на сгенерированную документацию. Однако вы можете явно использовать тег @public, чтобы другим было ясно, что вы намеревались сделать символ общедоступным.

В JSDoc 3, тег @public не влияет на область символа. Используйте теги @instance, @static и @global, чтобы изменить область символа.

Примеры

/**
 * The Thingy class is available to all.
 * @public
 * @class
 */
function Thingy() {
    /**
     * The Thingy~foo member. Note that 'foo' is still an inner member
     * of 'Thingy', in spite of the @public tag.
     * @public
     */
    var foo = 0;
}

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

• @доступ
• @глобальный
• @экземпляр
• @пакет
• @приватный
• @защищённый
• @статический