<param> (JavaScript)
Указывает сведения о документации для параметра функции или метода.
<param name="parameterName" type="ParameterType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" parameterArray="true|false" optional="true|false" value="code">description</param>
Параметры
name
Обязательное.Имя параметра.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.locid
Необязательный параметр.Идентификатор данных о локализации о параметре.Идентификатор и идентификатор элемента или он соответствует значению атрибута name в соединении в пакет сообщения указанному OpenAjax метаданных.Значение зависит от типа идентификатора формата, указанного в элементе <loc> (JavaScript).parameterArray
Необязательный параметр.Определяет, является ли документированный параметр может быть повторено в вызове функции аналогично повторных параметры, поддерживаемые в функции String.format.Значение true, чтобы указать, что параметр можно выполнить итерацию; в противном случае – значение false.Этот атрибут не используется Visual Studio для предоставления сведений о IntelliSense.optional
Необязательный параметр.Определяет, является ли документированный параметр является необязательным в вызывающей функции.Значение true, чтобы указать, что параметр является необязательным; в противном случае – значение false.value
Необязательный параметр.Указывает код, который должен быть вычислен для использования вместо кода самой функции технологии IntelliSense.Этот атрибут можно использовать для предоставления сведений о типе, если параметр типа является неопределенным.Например, можно использовать value=’1’ для визуализации параметр типа в виде числа.description
Необязательный параметр.Описание параметра.
Заметки
Один обязательный атрибут name.Все другие атрибуты являются необязательными.
Элементы, используемые для создания заметок к функции, как <summary> (JavaScript), <param> (JavaScript) и <returns> (JavaScript), должны быть помещены в теле функции перед всеми выписками.
Если несколько объектов, то <param>, имеющих одно и то же имя одного из элементов <param> используется и резервные элементы игнорируются.Реакция на событие, которое определяет, какой элемент используется не определена.Если name ссылается на несуществующий параметр, то элемент не учитывать.
Пример
В следующем примере кода показано, как использовать элемент <param>.
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when provided a radius parameter.</summary>
/// <param name="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}
// Uses of <param> with the value attribute.
function calculate(a) {
/// <param name='a' value='1'/>
a. // Completion list for a Number.
}
function calculate(a) {
/// <param name='a' value='{x:0,y:0}'/>
a. // x and y appear in the completion list.
}