@protected
Оглавление
Синтаксис
С помощью словаря тегов JSDoc (включен по умолчанию):
@protected
С помощью словаря тегов Closure Compiler:
@protected [{typeExpression}]
Обзор
Тег @protected помечает символ как защищённый. Обычно этот тег указывает, что символ доступен или должен использоваться только внутри текущего модуля.
По умолчанию символы, помеченные тегом @protected , будут отображаться в вашей документации. В JSDoc 3.3.0 и более поздних версиях вы можете изменить это поведение с помощью опции командной строки -a/--access.
Тег @protected эквивалентен тегу @access protected.
Примеры
В следующем примере экземпляр Thingy#_bar отображается в сгенерированной документации, но с аннотацией, указывающей, что он защищён:
/** @constructor */
function Thingy() {
/** @protected */
this._bar = 1;
}
Связанные ссылки
© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://jsdoc.app/tags-protected.html
