<field> (JavaScript)

Статья
02/20/2013

Указывает сведения о документации, включая описание, либо для поля или члена, определенные в объекте.

<field name="fieldName" static="true|false" type="FieldType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" helpKeyword="keyword" locid="descriptionID" value="code">description</field>

Параметры

name
Имя поля или члена.Если элемент <field> используется в функции конструктора, и определяет name тег элемента, к которому применяется.Если элемент <field> сразу помечает поле этот атрибут игнорировать и имя, используемое Visual Studio имя реального поля в исходном коде.
static
Необязательный параметр.Определяет, является ли поле член функции конструктора или член объекта, возвращенного функцией конструктора.Имеет значение true для отображения поля в качестве члена функции конструктора.Имеет значение false для отображения поля в качестве элемента объекта, возвращаемого функцией конструктора.
type
Необязательный параметр.Тип данных поля.Тип может иметь одно из следующих значений:
- Спецификация языка ECMAScript типа в ECMAScript 5, как Number и Object.
- Объект DOM, как HTMLElement, Window и Document.
- Функция конструктора javascript.
integer
Необязательный параметр.Если typeNumber, указывающее, является ли поле целое число.Значение true, чтобы указать, что поле целое число; в противном случае – значение false.Этот атрибут не используется Visual Studio для предоставления сведений о IntelliSense.
domElement
Необязательный параметр.Этот атрибут не рекомендуем; атрибут type имеет приоритет над этим атрибутом.Этот атрибут указывает, следует ли документированное поле элемента DOM.Значение true, чтобы указать, что поле элемента DOM; в противном случае – значение false.Если атрибут type не установлен и domElement установлено в true, то IntelliSense обрабатывает документированное поле как HTMLElement при завершении выписки.
mayBeNull
Необязательный параметр.Определяет, является ли документированное можно задать поле значение null.Значение true, чтобы указать, что поле можно установить в значение null; в противном случае – значение false.Значение по умолчанию — false.Этот атрибут не используется Visual Studio для предоставления сведений о IntelliSense.
elementType
Необязательный параметр.Если typeArray, то этот атрибут задает тип элементов в массиве.
elementInteger
Необязательный параметр.Если typeArray и elementTypeNumber, этот атрибут указывает, следует ли элементы в массиве целые числа.Значение true, чтобы указать, что элементы массива целые числа; в противном случае – значение false.Этот атрибут не используется Visual Studio для предоставления сведений о IntelliSense.
elementDomElement
Необязательный параметр.Этот атрибут не рекомендуем; атрибут elementType имеет приоритет над этим атрибутом.Если typeArray, этот атрибут указывает, следует ли элементы в массиве элементов DOM.Значение true для указания того, что элементы элементы DOM; в противном случае – значение false.Если атрибут elementType не установлен и elementDomElement установлено в true, то IntelliSense рассматривает каждый элемент массива как HTMLElement при завершении выписки.
elementMayBeNull
Необязательный параметр.Если typeArray, указывающее, является ли элементы массива можно установить в значение null.Значение true, чтобы указать, что элементы массива можно установить в значение null; в противном случае – значение false.Значение по умолчанию — false.Этот атрибут не используется Visual Studio для предоставления сведений о IntelliSense.
helpKeyword
Необязательный параметр.Ключевое слово для справки F1.
locid
Необязательный параметр.Идентификатор данных о локализации о поле.Идентификатор и идентификатор элемента или он соответствует значению атрибута name в соединении в пакет сообщения указанному OpenAjax метаданных.Значение зависит от типа формата идентификатора, заданной в теге <loc> (JavaScript).
value
Необязательный параметр.Указывает код, который должен быть вычислен для использования вместо кода самой функции технологии IntelliSense.Для <field> этот атрибут поддерживается для функций конструктора, но не поддерживается для литералов объекта.Этот атрибут можно использовать для предоставления сведений о типе, если тип поля не определен.Например, можно использовать value=’1’ для визуализации тип поля как число.
description
Необязательный параметр.Описание поля.

Заметки

Атрибут name необходим в том случае, если вы документируете поле в функции конструктора.Для всех других сценариев все атрибуты элемента <field> являются необязательными.

При документируете функцию конструктора, элемент <field> должен появиться сразу после объявления поля.Атрибут name должен соответствовать имени поля, которое используется в исходном коде.Для членов объектов, атрибут name можно опустить, если элемент <field> отображается сразу после объявления членов объекта.

Пример

В следующем примере кода показано, как использовать элемент <field>.

// Use of <field> in an object definition.
var Rectangle = {
    /// <field type = 'Number'>The width of the rectangle.</field>
    wid: 5,
    /// <field type = 'Number'>The length of the rectangle.</field>
    len: 0,
    /// <field type='Number'>Returns the area of the rectangle.</field>
    getArea: function (wid, len) {
        return len * wid;
    }
}

// Use of <field> in a constructor function.
// The name attribute is required.
function Engine() {
    /// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
    this.HorsePower = 150;
}

В следующем примере показано, как использовать элемент <field> с атрибутом static к true.

function Engine() {
    /// <field name='HorsePower' static='true' type='Number'>static field desc.</field>
}

Engine.HorsePower = 140;
// IntelliSense on the field is available here.
Engine.

В следующем примере показано, как использовать элемент <field> с атрибутом static к false.

function Engine() {
    /// <field name='HorsePower' static='false' type='Number'>Non-static field desc.</field>
}

Engine.HorsePower = 140;
var eng = new Engine();
// IntelliSense on the field is available here.
eng.

В следующем примере показано, как использовать элемент <field> с атрибутом value.

function calculator(a) {
    /// <field name='f' value='1'/>
}
new calculator().f.   // Completion list for a Number.

См. также

Основные понятия

Комментарии XML-документации (JavaScript)

Поделиться через