@package

Содержание

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

Синтаксис

С помощью словаря тегов JSDoc (включен по умолчанию):

@package

С помощью словаря тегов Closure Compiler:

@package [{typeExpression}]

Обзор

Тег @package помечает символ как предназначенный для пакета. Обычно это означает, что символ доступен только коду в той же директории, что и исходный файл этого символа. Этот тег доступен в JSDoc 3.5.0 и более поздних версиях.

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

Тег @package эквивалентен тегу @access package.

Примеры

В следующем примере, элемент экземпляра Thingy#_bar отображается в сгенерированной документации, но с аннотацией, указывающей, что он предназначен для пакета:

/** @constructor */
function Thingy() {
    /** @package */
    this._bar = 1;
}

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

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