@ignore

Оглавление

• Обзор
• Примеры

Обзор

Тег @ignore указывает, что символ в вашем коде никогда не должен отображаться в документации. Этот тег имеет приоритет над всеми другими.

Для большинства шаблонов JSDoc, включая шаблон по умолчанию, тег @ignore имеет следующие эффекты:

• Если вы используете тег @ignore вместе с тегом @class или тегом @module, весь класс или модуль будет исключён из документации.
• Если вы используете тег @ignore вместе с тегом @namespace, вы также должны добавить тег @ignore ко всем дочерним классам и пространствам имён. В противном случае ваша документация будет отображать дочерние классы и пространства имён, но с неполными именами.

Примеры

В следующем примере Jacket и Jacket#color не будут отображаться в документации.

В следующем примере пространство имён Clothes содержит класс Jacket. Тег @ignore должен быть добавлен как к Clothes, так и к Clothes.Jacket. Clothes, Clothes.Jacket, и Clothes.Jacket#color не будут отображаться в документации.