@access

Содержание

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

Синтаксис

@access <package|private|protected|public>

Обзор

Тег @access указывает уровень доступа к члену. Вы можете использовать тег @access в качестве синонима для других тегов:

• @access package эквивалентен @package. Этот вариант доступен в JSDoc 3.5.0 и более поздних версиях.
• @access private эквивалентен @private.
• @access protected эквивалентен @protected.
• @access public эквивалентен @public.

Приватные члены не отображаются в выходных данных, если JSDoc не запускается с параметром командной строки -p/--private. В JSDoc 3.3.0 и более поздних версиях вы также можете использовать -a/--access параметр командной строки для изменения этого поведения.

Обратите внимание, что уровень доступа doclet отличается от его области видимости. Например, если у Parent есть внутренняя переменная с именем child , которая документирована как @public, переменная child все равно будет обрабатываться как внутренняя переменная с именем Parent~child. Другими словами, переменная child будет иметь внутреннюю область видимости, даже если переменная является публичной. Для изменения области видимости doclet используйте теги @instance, @static и @global.

Примеры

/** @constructor */
function Thingy() {

    /** @access private */
    var foo = 0;

    /** @access protected */
    this._bar = 1;

    /** @access package */
    this.baz = 2;

    /** @access public */
    this.pez = 3;

}

// same as...

/** @constructor */
function OtherThingy() {

    /** @private */
    var foo = 0;

    /** @protected */
    this._bar = 1;

    /** @package */
    this.baz = 2;

    /** @public */
    this.pez = 3;

}

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

• @global
• @instance
• @package
• @private
• @protected
• @public
• @static