<loc> (JavaScript)
Określa lokalizację i typ pliku boczną, który zawiera informacje zlokalizowane IntelliSense.
<loc filename="filename" format="vsdoc|messagebundle" />
Parametry
filename
Opcjonalne.Nazwa głównego pliku pomocniczym, który zawiera informacje o lokalizacji dla kultury neutralnej.Podczas wyszukiwania informacji o lokalizacji Visual Studio, próbuje znaleźć kultury określonych wersji tego pliku.Na przykład jeśli filename jest jquery.xml, Visual Studio wyszukuje właściwy folder kultury (jak JA) w tej samej lokalizacji co plik js, który zawiera <loc> element.Odnajduje folder kultury sprawdza, czy istnieje plik jquery.xml w nim.Jeśli nie może zlokalizować poprawny plik, zamiast tego używa zasady lokalizacji zasobów zarządzanych.Wartość domyślna dla filename jest nazwą bieżącego pliku, ale z rozszerzeniem XML .js.format
Opcjonalne.Typ używany do lokalizacji pliku pomocniczym.Użyj messagebundle stosowanie wiązki wiadomości definiowane przez metadane Otwórz Ajax.messagebundlejest zalecany.Jednak ten format nie jest obsługiwany, Ajax firmy Microsoft lub w plikach .winmd.Użyj vsdoc do określenia standardowego formatu lokalizacja.NET Framework jest używana przez Microsoft Ajax i obsługi systemu Windows.Ten atrybut jest opcjonalny.vsdocjest to domyślny format.
Uwagi
<loc> Element musi pojawić się u góry pliku w tej samej sekcji jako <reference> element.Użycie zasady <loc> elementu są takie same, jak <reference> element.Aby uzyskać więcej informacji, zobacz sekcję "Dyrektyw odniesienia" w Technologia JavaScript IntelliSense.
Visual Studio przetwarza pojedynczego <loc> element dla każdego pliku js.Jeśli wiele <loc> występują elementy tylko jeden <loc> element jest używany.Zachowanie dla ustalenia, które <loc> z elementów nie jest zdefiniowany.
Używając formatu wiadomości paczki, użyj locid atrybutu w komentarzy dokumentacji XML do określenia name wartość atrybutu.
Przykład
Poniższy przykład pokazuje, jak używać <loc> element z formatu messagebundle.Dodaj następujący kod XML w pliku o nazwie messageFilename.xml i umieścić go w folderze poprawne kultury, jak określono w opisie filename parametru.
<?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>
Na przykład messagebundle Dodaj następujący kod do pliku JavaScript w projekcie.<loc> Element musi pojawić się jako pierwszy wiersz w pliku JavaScript.Opisy w ten kod zostanie zastąpiony przez opisy zlokalizowane, jeśli dostępne.
/// <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>
}
Poniższy przykład używa formatu VSDoc.Dodaj następujący kod XML w pliku o nazwie scriptFilename.xml i umieścić go w odpowiednim folderze kultury.
<?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>
Na przykład VSDoc Dodaj następujący kod do pliku JavaScript w projekcie.Opisy w ten kod zostanie zastąpiony przez opisy zlokalizowane, jeśli dostępne.
/// <loc filename="scriptFilename.xml" format="vsdoc" />
function illuminate(a)
{
/// <summary locid='M:illuminate'>description</summary>
/// <param name='a' type='Number'>parameter a description</param>
}