@instance

Оглавление

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

Обзор

Использование тега @instance пометит символ как член экземпляра его родительского символа. Это означает, что к нему можно обратиться как «Родитель#Дочерний».

Использование @instance переопределит стандартную область действия doclet (если он не находится в глобальной области видимости, в этом случае он останется глобальным).

Примеры

Следующий пример — длинный способ записи «@function MyNamespace#myFunction»:

Более полезно, вы можете использовать тег @instance для переопределения области видимости, которую JSDoc определяет. Например, вы можете указать, что статический член используется как член экземпляра:

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

• @global
• @inner
• @static