<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.
A DOM object, such as HTMLElement, Window, and Document.
JavaScript 생성자 함수입니다.
integer
선택 사항입니다.경우 type 는 Number, 매개 변수는 정수 인지 여부를 지정 합니다.설정 true 매개 변수 정수; 있음을 나타내려면 그렇지 않으면 설정 false.이 특성 IntelliSense 정보를 제공 하는 Visual Studio 사용 되지 않습니다.domElement
선택 사항입니다.이 특성은 사용 되지 않습니다. type 특성이이 특성 보다 우선 합니다.이 특성 문서화 된 매개 변수는 DOM 요소 인지 여부를 지정 합니다.설정 true DOM 요소입니다; 매개 변수가 되도록 지정 하려면 그렇지 않으면 설정 false.경우는 type 특성이 설정 되지 않습니다와 domElement 로 설정 된 true, IntelliSense로 문서화 된 매개 변수를 처리는 HTMLElement 문 완성 기능을 수행 하는 경우.mayBeNull
선택 사항입니다.문서화 된 매개 변수를 설정할 수 있는지 여부를 지정 하려면 null입니다.설정 true 매개 변수를 설정할 수 있습니다 나타내기 위해 null입니다. 그렇지 않으면 설정 false.기본값은 false입니다.이 특성 IntelliSense 정보를 제공 하는 Visual Studio 사용 되지 않습니다.elementType
선택 사항입니다.경우 type 는 Array,이 특성의 배열에 요소 형식을 지정 합니다.elementInteger
선택 사항입니다.경우 type 입니다 Array 및 elementType 입니다 Number, 배열에 있는 요소의 정수 인지이 특성을 지정 합니다.설정 true 배열에 있는 요소의 정수; 나타내기 위해 그렇지 않으면 설정 false.이 특성 IntelliSense 정보를 제공 하는 Visual Studio 사용 되지 않습니다.elementDomElement
선택 사항입니다.이 특성은 사용 되지 않습니다. elementType 특성이이 특성 보다 우선 합니다.경우 type 는 Array,이 특성을 배열에 있는 요소의 DOM 요소 인지 지정 합니다.설정 true 요소를 DOM 요소; 지정 하려면 그렇지 않으면 설정 false.경우는 elementType 특성이 설정 되지 않습니다와 elementDomElement 로 설정 된 true, IntelliSense로 배열의 각 요소를 처리는 HTMLElement 문 완성 기능을 수행 하는 경우.elementMayBeNull
선택 사항입니다.경우 type 는 Array, 배열에서 요소를 설정할 수 있는지 여부를 지정 합니다. null로.설정 true 배열에 있는 요소의 설정 될 수 있음을 나타내기 위해 null입니다. 그렇지 않으면 설정 false.기본값은 false입니다.이 특성 IntelliSense 정보를 제공 하는 Visual Studio 사용 되지 않습니다.locid
선택 사항입니다.지역화 매개 변수 정보에 대 한 식별자입니다.두 멤버의 식별자입니다 ID 또는 그에 해당 하는 name 특성 값 OpenAjax 메타 데이터에 의해 정의 된 메시지 번들에.식별자 형식에 지정 된 형식에 따라 달라 집니다를 <loc>(JavaScript) 요소입니다.parameterArray
선택 사항입니다.문서화 된 매개 변수 함수 호출에서 매개 변수에서 지원 되는 반복에 유사한 반복 될 수 있는지 여부를 지정 된 String.format 함수입니다.설정 true 매개 변수는 반복 될 수 있음을 나타내려면 그렇지 않으면 설정 false.이 특성 IntelliSense 정보를 제공 하는 Visual Studio 사용 되지 않습니다.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.
}