<loc> (JavaScript)
Especifica la ubicación y el tipo de archivo car lateral que proporciona información traducida de IntelliSense.
<loc filename="filename" format="vsdoc|messagebundle" />
Parámetros
filename
Opcional.El nombre de raíz del archivo car lateral que contiene información de localización para la referencia cultural neutra.Cuando las búsquedas de Visual Studio para la información de localización, se intentan encontrar una versión cultura- específica de este archivo.Por ejemplo, si filename es jquery.xml, búsquedas de Visual Studio para la carpeta cultura- concreta correcta (como JA) en la misma ubicación que el archivo .js que contiene el elemento de <loc> .Si encuentra la carpeta cultura- concreta, comprueba si un archivo de jquery.xml existe en él.Si no puede localizar el archivo correcto, en su lugar utiliza reglas administradas de la ubicación del recurso.El valor predeterminado para filename es el nombre del archivo actual, pero con una extensión .xml en lugar de .js.format
Opcional.El tipo de archivo car lateral utilizado para la localización.Uso messagebundle de especificar el uso de los paquetes de mensaje definido por metadatos abierto de AJAX.messagebundle es el formato recomendado.Sin embargo, este formato no se admite en Microsoft Ajax o en archivos de .winmd.Uso vsdoc de especificar el formato de localización de .NET Framework del estándar que usa Microsoft Ajax y Windows en tiempo de ejecución.Este atributo es opcional.vsdoc es el formato predeterminado.
Comentarios
El elemento de <loc> debe aparecer en la parte superior del archivo en la misma sección que el elemento de <reference> .Las reglas de uso del elemento de <loc> son iguales que el elemento de <reference> .Para obtener más información, vea la sección “las directivas de referencias” en IntelliSense para JavaScript.
Visual Studio procesa un único elemento de <loc> para cada archivo .js.Si hay varios elementos de <loc> están presentes, sólo se utiliza un solo elemento de <loc> .Comportamiento para determinar el elemento de <loc> a utilizar no está definido.
Al utilizar formato de paquete del mensaje, utilice el atributo de locid en Comentarios de documentación XML para especificar el valor de atributo name .
Ejemplo
El ejemplo siguiente se muestra cómo utilizar el elemento de <loc> con formato de messagebundle.Agregue el siguiente código XML en un archivo denominado messageFilename.xml y coloque el archivo en la carpeta cultura- concreta correcta, tal como se especifica en la descripción del parámetro de 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>
En el ejemplo de messagebundle, agregue el código siguiente a un archivo JavaScript en el proyecto.El elemento de <loc> debe aparecer como la primera línea del archivo JavaScript.Las descripciones en este código se reemplazarán por descripciones traducidas, si están 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>
}
El ejemplo siguiente se utiliza el formato de VSDoc.Agregue el siguiente código XML en un archivo denominado scriptFilename.xml y coloque el archivo en la carpeta cultura- concreta correcta.
<?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>
Para el ejemplo de VSDoc, agregue el código siguiente a un archivo JavaScript en el proyecto.Las descripciones en este código se reemplazarán por descripciones traducidas, si están 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>
}