<signature>(JavaScript)
오버 로드 된 함수에 대 한 설명서를 제공 하는 메서드 또는 함수에 대 한 관련된 요소를 그룹화 합니다.
<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature>
매개 변수
externalid
선택 사항입니다.경우는 format 특성에 대 한의 <loc>(JavaScript) 요소인 vsdoc, 멤버 ID를 사용 하는 서명과 관련 된 XML 코드를 찾으려면이 특성을 지정 합니다.달리는 locid 특성을이 특성에 지정이 ID가 있는 구성원의 모든 요소를 로드할 수 있어야 합니다.또한 XML 코드에 관련 된 설명 정보는 서명에서 지정 된 요소와 병합 됩니다.이 같은 추가 요소를 지정할 수 있습니다 <capability>, 사이드카 파일 없이 소스 파일에서 지정 합니다.externalid특성은 선택적 요소입니다.externalFile
선택 사항입니다.찾을 파일의 이름을 지정은 externalid.이 특성이 없는 경우 무시 됩니다 externalid 있습니다.이 특성은 선택적 요소입니다.기본값은 파일 확장명은.js 대신.xml 이지만 현재 파일의 이름입니다.기본적으로 지역화에 대 한 관리 되는 리소스 조회 규칙 파일을 찾는 데 사용 됩니다.helpKeyword
선택 사항입니다.에 대 한 F1 도움말 키워드입니다.locid
선택 사항입니다.필드에 대 한 지역화 정보에 대 한 식별자입니다.두 멤버 식별자입니다 ID 또는 해당는 name 특성 값 OpenAjax 메타 데이터에 의해 정의 된 메시지 번들에서.식별자 형식에 따라 달라 집니다에 지정 된 형식에는 <loc>(JavaScript) 태그.
설명
하나를 사용 <signature> 요소 각각에 대해 오버 로드 된 함수 설명 하거나.js 파일 하나를 사용 <signature> 요소에 지정 된 각 외부 멤버 ID입니다.
<signature> 함수 본문 모든 문 앞에 요소를 배치 해야 합니다.사용 하는 경우 <summary>(JavaScript), <param>(JavaScript), 또는 <returns>(JavaScript) 요소는 <signature> 요소를 요소 안에 놓습니다는 <signature> 블록.
예제
다음 코드 예제에서는 해당 <signature> 요소입니다.
// Use of <signature> with externalid.
// Requires use of the <loc> tag to identify the external functions.
function illuminate(light) {
/// <signature externalid='M:Windows.Devices.Light.Illuminate()' />
/// <signature externalid='M:Windows.Devices.Light.Illuminate(System.Int32)'>
/// <param name='light' type='Number' />
/// </signature>
}
// Use of <signature> for overloads implemented in JavaScript.
function add(a, b) {
/// <signature>
/// <summary>function summary 1</summary>
/// <param name="a" type="Number">The first number</param>
/// <param name="b" type="Number">The second number</param>
/// <returns type="Number" />
/// </signature>
/// <signature>
/// <summary>function summary 2 – differ by number of params</summary>
/// <param name="a" type="Number">Only 1 parameter</param>
/// <returns type="Number" />
/// </signature>
/// <signature>
/// <summary>function summary 3 – differ by parameter type</summary>
/// <param name="a" type="Number">Number parameter</param>
/// <param name="b" type="String">String parameter</param>
/// <returns type="Number" />
/// </signature>
/// <signature>
/// <summary>function summary 4 – differ by return type</summary>
/// <param name="a" type="Number">The first number</param>
/// <param name="b" type="Number">The second number</param>
/// <returns type="String" />
/// </signature>
return a + b;
}