<signature> (JavaScript)
Gruppiert einen Satz von verwandten Elementen für eine Funktion oder Methode, um die Dokumentation für überladene Funktionen bereitzustellen.
<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature>
Parameter
externalid
Dies ist optional.Wenn die format -Attribut für die <loc> (JavaScript) Element ist vsdoc, dieses Attribut gibt den Member-ID verwendet, um den XML-Code zu suchen, die mit der Signatur zugeordnet ist.Im Gegensatz zu den locid -Attribut für dieses Attribut gibt an, dass alle Elemente in das Mitglied mit dieser ID geladen werden soll.Mit den Elementen in der Signatur angegeben werden auch alle zugeordneten Beschreibungsinformationen in den XML-Code zusammengeführt.Dadurch können Sie zusätzliche Elemente angeben, z. B. <capability>, in der Datei Beiwagen, ohne sie in der Quelldatei angeben.externalidist ein optionales Attribut.externalFile
Dies ist optional.Gibt den Namen der Datei in der sich die externalid.Dieses Attribut wird ignoriert, wenn keine externalid vorhanden ist.Dies ist ein optionales Attribut.Der Standardwert ist der Name der aktuellen Datei jedoch mit der Dateierweiterung .xml statt js.Standardmäßig werden verwaltete Ressource Lookup Regeln für die Lokalisierung verwendet, um die Datei zu suchen.helpKeyword
Dies ist optional.Das Schlüsselwort für die F1-Hilfe.locid
Dies ist optional.Der Bezeichner für die von Lokalisierungsinformationen über das Feld.Der Bezeichner ist entweder ein Produkt-ID oder es entspricht der name Attributwert im Bundle Nachricht durch OpenAjax-Metadaten definiert.Der Typ des Bezeichners im angegebenen Format hängt von der <loc> (JavaScript) Tag.
Hinweise
Verwenden Sie eine <signature> -Element für jede überladene Funktionsbeschreibung in der js-Datei, oder verwenden Sie eine <signature> -Element für jede externe Member-ID angegeben.
Die <signature> Element muss sich im Hauptteil Funktion vor allen Anweisungen.Bei Verwendung <summary> (JavaScript), <param> (JavaScript), oder <returns> (JavaScript) Elemente mit den <signature> Element, platzieren Sie die anderen Elemente in der <signature> Block.
Beispiel
Im folgenden Codebeispiel wird veranschaulicht, wie mithilfe der <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;
}