<signature> (JavaScript)
Regroupe un ensemble d'éléments associés pour une fonction ou une méthode pour fournir une documentation pour les fonctions surchargées.
<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature>
Paramètres
externalid
Optionnel.Si la format d'attribut pour la <loc> (JavaScript) élément est vsdoc, cet attribut spécifie le membre ID utilisé pour localiser le code XML qui est associé à la signature.Contrairement à la locid attribut, cet attribut spécifie que tous les éléments dans le membre qui a cet ID doivent être chargés.Les informations de description associé présentes dans le code XML seront également fusionnées avec les éléments spécifiés dans la signature.Vous pouvez ainsi spécifier d'autres éléments, tels que <capability>, dans le fichier side-car sans les spécifier dans le fichier source.externalidest un attribut facultatif.externalFile
Optionnel.Spécifie le nom du fichier dans lequel vous souhaitez trouver la externalid.Cet attribut est ignoré si aucune externalid est présent.Il s'agit d'un attribut facultatif.La valeur par défaut est le nom du fichier actuel mais avec une extension de fichier du fichier .xml au lieu de .js.Par défaut, les règles de recherche de ressource gérée pour la localisation sont utilisés pour localiser le fichier.helpKeyword
Optionnel.Le mot clé d'aide F1.locid
Optionnel.L'identificateur pour les informations de localisation sur le champ.L'identificateur est soit un membre ID ou elle correspond à la name valeur dans une offre groupée de message définie par les métadonnées de OpenAjax d'attribut.Le type d'identificateur dépend du format spécifié dans la <loc> (JavaScript) tag.
Notes
Utiliser un <signature> élément for each surchargé dans le fichier .js ou utilisez une description de la fonction <signature> élément pour chaque ID de membre externe spécifié.
Le <signature> élément doit être placé dans le corps de la fonction avant toute instruction.Lorsque vous utilisez <summary> (JavaScript), <param> (JavaScript), ou <returns> (JavaScript) éléments avec la <signature> élément, placer les autres éléments à l'intérieur de la <signature> bloc.
Exemple
L'exemple de code suivant montre comment utiliser la <signature> élément.
// 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;
}