<signature> (JavaScript)
Raggruppa un insieme di elementi correlati per una funzione o un metodo per fornire la documentazione per le funzioni in overload.
<signature externalid="id" externalFile="filename"
helpKeyword="keyword" locid="descriptionID">
</signature>
Parametri
externalid
Parametro facoltativo.Se l'attributo format per l'elemento <loc> (JavaScript) è vsdoc, questo attributo specifica il membro ID utilizzato per individuare il codice XML associato alla firma.A differenza dell'attributo locid, questo attributo specifica che tutti gli elementi nel membro con questo ID devono essere caricati.Qualsiasi informazione di descrizione associata presente nel codice XML verrà unita agli elementi specificati nella firma.Ciò consente di specificare ulteriori elementi, come <capability>, nel file sidecar senza specificarli nel file di origine.externalid è un attributo opzionale.externalFile
Parametro facoltativo.Specifica il nome del file in cui cercare externalid.Questo attributo viene ignorato se nessun externalid è presente.Questo è un attributo opzionale.Il valore predefinito è il nome del file corrente ma con estensione .xml anziché .js.Per impostazione predefinita, le regole di ricerca della risorsa gestita per la localizzazione vengono utilizzate per individuare il file.helpKeyword
Parametro facoltativo.La parola chiave per la guida richiamata tramite F1.locid
Parametro facoltativo.L'identificatore per le informazioni sulla localizzazione riguardo al campo.L'identificatore è un membro ID o corrisponde al valore dell'attributo name in un gruppo di messaggi definiti dai metadati di OpenAjax.Il tipo dell'identificatore dipende dal formato specificato nel tag <loc> (JavaScript).
Note
Utilizzare un elemento <signature> per ogni descrizione di funzione in overload nel file .js, oppure usare un elemento <signature> per ogni membro esterno ID specificato.
L'elemento <signature> deve essere inserito nel corpo della funzione prima delle istruzioni.Quando si utilizza <summary> (JavaScript), <param> (JavaScript), o elementi <returns> (JavaScript) con l'elemento <signature>, posizionare gli altri elementi nel blocco <signature>.
Esempio
Nell'esempio di codice riportato di seguito viene illustrato come utilizzare l'elemento <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;
}