@private

Содержание

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

Синтаксис

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

@private

С словарем тегов Closure Compiler:

@private [{typeExpression}]

Обзор

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

Тег @private не наследуется дочерними членами. Например, если тег @private добавлен к пространству имён, члены пространства имён все еще могут отображаться в сгенерированном выводе; поскольку пространство имён является приватным, путь имени членов не будет включать пространство имён.

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

Примеры

В следующем примере Documents и Documents.Newspaper отображаются в сгенерированной документации, но не Documents.Diary.

/** @namespace */
var Documents = {
    /**
     * An ordinary newspaper.
     */
    Newspaper: 1,
    /**
     * My diary.
     * @private
     */
    Diary: 2
};

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

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