<signature> (JavaScript)
Raggruppa un insieme di elementi correlati di una funzione o un metodo per fornire documentazione per le funzioni in overload.
<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature>
Parametri
externalid
Opzionale.Se il format di attributo per la <loc> (JavaScript) elemento è vsdoc, questo attributo specifica il membro ID utilizzato per individuare il codice XML che ha associato con la firma.A differenza di locid attributo, questo attributo specifica che tutti gli elementi nel membro con questo ID devono essere caricati.Le informazioni di descrizione associati presenti nel codice XML verranno unite anche gli elementi specificati nella firma.Ciò consente di specificare ulteriori elementi, ad esempio <capability>, nel file carrozzino senza specificare il file di origine.externalidè un attributo facoltativo.externalFile
Opzionale.Specifica il nome del file in cui trovare il externalid.Questo attributo viene ignorato se non externalid è presente.Si tratta di un attributo facoltativo.Il valore predefinito è il nome del file corrente, ma con estensione XML anziché js.Per impostazione predefinita, le regole di ricerca di risorsa gestita per la localizzazione vengono utilizzate per individuare il file.helpKeyword
Opzionale.La parola chiave F1 Guida in linea.locid
Opzionale.Identificatore di informazioni di localizzazione sul campo.L'identificatore è un membro ID o corrisponde alla name valore in un raggruppamento di messaggi definito da metadati OpenAjax di attributo.Il tipo di identificatore dipende dal formato specificato nel <loc> (JavaScript) tag.
Note
Utilizzare una <signature> per ogni elemento di descrizione della funzione nel file con estensione js o utilizzare uno di overload <signature> (elemento) per ogni ID membro esterno specificato.
Il <signature> elemento deve essere inserito nel corpo della funzione prima delle istruzioni.Quando si utilizza <summary> (JavaScript), <param> (JavaScript), o <returns> (JavaScript) gli elementi con il <signature> elemento, inserire altri elementi all'interno di <signature> blocco.
Esempio
Nell'esempio di codice riportato di seguito viene illustrato come utilizzare il <signature> elemento.
// 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;
}