<signature> (JavaScript)
Groupe un ensemble d'éléments connexes pour une fonction ou une méthode fournit la documentation pour les fonctions surchargées.
<signature externalid="id" externalFile="filename"
helpKeyword="keyword" locid="descriptionID">
</signature>
Paramètres
externalid
Optionnel.Si l'attribut format pour l'élément <loc> (JavaScript) est vsdoc, cet attribut spécifie l'ID membre utilisé pour localiser le code XML associé à la signature.Contrairement à l'attribut locid, cet attribut spécifie que tous les éléments du membre qui possède cet ID doivent être chargés.Toutes les informations associées de description actuelles dans le code XML sont également fusionnées avec les éléments spécifiés dans la signature.Cela vous permet de spécifier des éléments supplémentaires, par exemple <capability>, dans le fichier de sidecar sans les spécifier dans le fichier source.externalid est un attribut facultatif.externalFile
Optionnel.Spécifie le nom du fichier dans lequel vous pouvez rechercher externalid.Cet attribut est ignoré si aucun externalid n'est présent.C'est un attribut facultatif.La valeur par défaut est le nom du fichier actif alors avec une extension de fichier .xml au lieu .js.Par défaut, les règles de recherche de ressource managée pour la localisation sont utilisées pour rechercher le fichier.helpKeyword
Optionnel.Le mot clé de l'aide F1.locid
Optionnel.L'identificateur pour les informations de localisation sur le champ.L'identificateur est ou un ID membre ou il correspond à la valeur d'attribut name dans un paquet de message défini par les métadonnées d'OpenAjax.Le type d'identificateur dépend du format spécifié dans la balise <loc> (JavaScript).
Notes
Utilisez un élément <signature> pour chaque description surchargée de la fonction dans le fichier .js, ou utiliser un élément <signature> pour chaque ID membre externe spécifié.
L'élément <signature> doit être placé dans le corps de la fonction avant les instructions.Lorsque vous utilisez <summary> (JavaScript), <param> (JavaScript), ou les éléments <returns> (JavaScript) avec l'élément <signature>, placez les autres éléments à l'intérieur du bloc d'<signature>.
Exemple
L'exemple de code suivant indique comment utiliser l'élément <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;
}