<loc> (JavaScript)
Gibt den Speicherort und den Typ der Beiwagendatei an, die lokalisierte IntelliSense-Informationen bereitstellt.
<loc filename="filename" format="vsdoc|messagebundle" />
Parameter
filename
Dies ist optional.Der Stammname der Beiwagendatei, die Lokalisierungsinformationen für die neutrale Kultur enthält.Wenn wird diese von Visual zu Lokalisierungsinformation, versucht, eine kulturspezifische Version dieser Datei zu suchen.Wenn filename jquery.xml ist, wird diese von Visual für die richtige besondere Ordner (wie Sie) am selben Speicherort wie die JS-Datei, der das <loc>-Element enthält.Wenn die besondere Ordner isoliert, überprüft er, ob eine jquery.xml-Datei darin vorhanden ist.Wenn die richtige Datei nicht finden kann, wird stattdessen verwaltete Ressourcenspeicherortregeln.Der Standardwert für filename ist der Name der aktuellen Datei, jedoch mit einer Erweiterung statt .js.format
Dies ist optional.Der Typ der Beiwagendatei verwendet für die Lokalisierung.Verwendung messagebundle, die Verwendung von den Meldungsbündeln anzugeben definiert durch Open AJAX Metadaten.messagebundle ist das empfohlene Format.Allerdings wird dieses Format nicht in Microsoft AJAX oder in WINMD-Dateien unterstützt.Verwenden Sie vsdoc, um das .NET Framework-Standardlokalisierungsformat anzugeben, das von Microsoft AJAX und Windows Runtime verwendet wird.Dieses Attribut ist optional.vsdoc ist das Standardformat.
Hinweise
Das <loc>-Element muss am Anfang der Datei im gleichen Abschnitt wie das <reference>-Element angezeigt werden.Verwendungsregeln für das Element <loc> sind die gleichen wie das <reference>-Element.Weitere Informationen finden Sie im Abschnitt "Bezugsdirektiven" in JavaScript IntelliSense.
Visual Studio verarbeitet ein einzelnes Element <loc> für jede JS-Datei.Wenn mehr, <loc>-Elemente sind nur vorhanden, ein einzelnes Element <loc> verwendet wird.Verhalten für Situationen, die zu verwendende <loc>-Element nicht definiert ist.
Wenn Sie Meldungsbündelformat verwenden, verwenden Sie das Attribut in locid XML-Dokumentationskommentaren, um den name-Attributwert anzugeben.
Beispiel
Das folgende Beispiel zeigt, wie das <loc>-Element mit messagebundle Format verwendet.Fügen Sie das folgende XML einer Datei hinzu, die messageFilename.xml namens und speichern Sie die Datei in der richtigen besonderen Ordner, wie in der Beschreibung des filename-Parameters angegeben.
<?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>
Für das messagebundle Beispiel fügen Sie den folgenden Code einer JavaScript-Datei im Projekt hinzu.Das Element muss <loc> werden wie die erste Zeile in der JavaScript-Datei.Die Beschreibungen in diesem Code werden durch lokalisierte Beschreibungen ersetzt, wenn verfügbar.
/// <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>
}
Im folgenden Beispiel wird VSDoc-Format.Fügen Sie das folgende XML einer Datei hinzu, die scriptFilename.xml namens und speichern Sie die Datei in der richtigen besonderen Ordner.
<?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>
Für das VSDoc-Beispiel fügen Sie folgenden Code einer JavaScript-Datei im Projekt hinzu.Die Beschreibungen in diesem Code werden durch lokalisierte Beschreibungen ersetzt, wenn verfügbar.
/// <loc filename="scriptFilename.xml" format="vsdoc" />
function illuminate(a)
{
/// <summary locid='M:illuminate'>description</summary>
/// <param name='a' type='Number'>parameter a description</param>
}