<signature> (JavaScript)
Grupuje zestaw powiązanych elementów dla funkcji lub metody przedstawienie dokumentacji dla funkcji zastąpionej.
<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature>
Parametry
externalid
Opcjonalne.Jeśli format atrybutu dla <loc> (JavaScript) jest elementem vsdoc, ten atrybut określa członka identyfikator używany do lokalizowania kod XML, który ma być związany z podpisem.W odróżnieniu od locid atrybut, ten atrybut określa, że wszystkie elementy członkowskie, w tym identyfikatorze powinien być ładowany.Informacje znajdujące się w kodzie XML skojarzony opis również zostaną scalone z elementów wymienionych w podpisie.Dzięki temu można określić dodatkowe elementy, takie jak <capability>, w pliku pomocniczym bez określania ich w pliku źródłowym.externalidjest atrybut opcjonalny.externalFile
Opcjonalne.Określa nazwę pliku, w którym odnaleźć externalid.Atrybut ten jest ignorowany, jeśli nie externalid jest obecny.Jest to atrybut opcjonalny.Wartość domyślna jest nazwą bieżącego pliku, ale z rozszerzeniem .xml zamiast .js.Domyślnie zasady wyszukiwania zasobów zarządzanych lokalizacji są używane do zlokalizować plik.helpKeyword
Opcjonalne.Słowo kluczowe Pomocy F1.locid
Opcjonalne.Identyfikator lokalizacji informacji na temat pola.Identyfikator jest albo członkiem lub identyfikator odpowiada name wartość w wiązce wiadomości definiowane przez metadane OpenAjax atrybutu.Typ identyfikatora zależy od formatu, określonego w <loc> (JavaScript) tag.
Uwagi
Użyj jednej <signature> element dla każdego przeciążony opis funkcji w pliku .js lub użyj jednej <signature> element dla każdego Identyfikatora zewnętrznego Członkowskich określone.
<signature> Elementu muszą być umieszczone w treści funkcji przed wszelkie oświadczenia.Podczas korzystania z <summary> (JavaScript), <param> (JavaScript), lub <returns> (JavaScript) elementy z <signature> element, inne elementy wewnątrz <signature> bloku.
Przykład
Poniższy przykład kodu pokazuje, jak używać <signature> element.
// 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;
}