<loc> (JavaScript)
Spécifie l'emplacement et le type du fichier de sidecar qui fournit des informations localisées Intellisense.
<loc filename="filename" format="vsdoc|messagebundle" />
Paramètres
filename
Optionnel.Le nom racine du fichier de sidecar qui contient les informations de localisation pour la culture neutre.Lorsque trouve Visual Studio pour les informations de localisation, il tente de rechercher une version spécifique à la culture de ce fichier.Par exemple, si filename est jquery.xml, recherche de Visual Studio pour le dossier spécifique à la culture approprié (comme JA) dans le même emplacement que le fichier .js qui contient l'élément d' <loc> .S'il trouve le dossier spécifique à la culture, il vérifie si un fichier de jquery.xml existe dans celui-ci.S'il ne peut pas trouver le fichier approprié, il utilise à la place des règles d'emplacement de ressources managées.La valeur par défaut pour filename est le nom du fichier en cours, mais avec une extension .xml au lieu de .js.format
Optionnel.Le type de fichier de sidecar utilisé pour la localisation.Utilisation messagebundle de spécifier l'utilisation des paquets de messages définis par les métadonnées Open AJAX.messagebundle est le format recommandé.Toutefois, ce format n'est pas pris en charge dans Microsoft Ajax ou dans des fichiers de .winmd.Utilisez vsdoc pour spécifier le format standard de localisation du .NET Framework utilisée par Microsoft Ajax et les fenêtres d'exécution.Cet attribut est facultatif.vsdoc agit du format par défaut.
Notes
L'élément d' <loc> doit apparaître au début du fichier dans la même section que l'élément d' <reference> .Les règles d'utilisation pour l'élément d' <loc> sont identiques à l'élément d' <reference> .Pour plus d'informations, consultez la section « directives de référence » dans IntelliSense JavaScript.
Visual Studio traite un élément dans <loc> pour chaque fichier .js.Si plusieurs éléments d' <loc> sont présents, seul un élément dans <loc> est utilisé.Comportement pour déterminer l'élément d' <loc> à utiliser n'est pas défini.
En utilisant le format de pack de message, utilisez l'attribut de locid dans les commentaires de documentation XML pour spécifier la valeur d'attribut d' name .
Exemple
L'exemple suivant indique comment utiliser l'élément d' <loc> avec le format de messagebundle.Ajoutez le XML suivant dans un fichier nommé messageFilename.xml et placez le fichier dans le répertoire spécifique à la culture approprié, comme spécifié dans la description du paramètre d' filename .
<?xml version="1.0" encoding="utf-8" ?>
<messagebundle>
<msg name="1">A class that represents a rectangle</msg>
<msg name="2">The height of a rectangle</msg>
<msg name="3">The width of a rectangle</msg>
</messagebundle>
Pour l'exemple de messagebundle, ajoutez le code suivant dans un fichier JavaScript dans votre projet.L'élément d' <loc> doit apparaître comme première ligne dans le fichier JavaScript.Les descriptions dans ce code seront remplacées par les descriptions localisées, si disponibles.
/// <loc filename="messageFilename.xml" format="messagebundle"/>
function doSomething(a,b)
{
/// <summary locid='1'>description</summary>
/// <param name='a' locid='2'>parameter a description</param>
/// <param name='b' locid='3'>parameter b description</param>
}
l'exemple suivant utilise le format de VSDoc.Ajoutez le XML suivant dans un fichier nommé scriptFilename.xml et placez le fichier dans le répertoire spécifique à la culture approprié.
<?xml version="1.0" encoding="utf-8" ?>
<doc>
<assembly>
<name>Lights</name>
</assembly>
<members>
<member name="M:illuminate">
<summary>Activates a light. </summary>
<param name='a'>The light to activate. </param>
</member>
</members>
</doc>
Pour l'exemple de VSDoc, ajoutez le code suivant dans un fichier JavaScript dans votre projet.Les descriptions dans ce code seront remplacées par les descriptions localisées, si disponibles.
/// <loc filename="scriptFilename.xml" format="vsdoc" />
function illuminate(a)
{
/// <summary locid='M:illuminate'>description</summary>
/// <param name='a' type='Number'>parameter a description</param>
}