@namespace

Содержание

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

Синтаксис

@namespace [[{<type>}] <SomeName>]

Обзор

Тег @namespace указывает, что объект создаёт пространство имён для своих членов. Также можно написать виртуальный комментарий JSDoc, определяющий пространство имён, используемое в вашем коде.

Если пространство имён определено символом, отличным от объекта-литерала, вы можете включить выражение типа вместе с тегом @namespace. Если тег @namespace включает тип, он также должен включать имя.

Возможно, вам нужно документировать пространство имён, имя которого включает необычные символы, такие как "#" или "!". В этих случаях при документировании или ссылке на пространство имён вы должны добавить кавычки вокруг части пространства имён, включающей необычные символы. Подробности см. в примерах ниже.

Примеры

/**
 * My namespace.
 * @namespace
 */
var MyNamespace = {
    /** documented as MyNamespace.foo */
    foo: function() {},
    /** documented as MyNamespace.bar */
    bar: 1
};

/**
 * A namespace.
 * @namespace MyNamespace
 */

/**
 * A function in MyNamespace (MyNamespace.myFunction).
 * @function myFunction
 * @memberof MyNamespace
 */

Если @namespace включает символ, имя которого содержит необычные символы, вы должны заключить имя символа в двойные кавычки. Если имя символа уже содержит одну или несколько двойных кавычек, экранируйте двойные кавычки ведущей обратной косой чертой (\).

/** @namespace window */

/**
 * Shorthand for the alert function.
 * Refer to it as {@link window."!"} (note the double quotes).
 */
window["!"] = function(msg) { alert(msg); };

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

@module