Condividi tramite


<loc> (JavaScript)

Specifica la posizione e il tipo di sidecar che fornisce informazioni localizzate IntelliSense.

<loc filename="filename" format="vsdoc|messagebundle" />

Parametri

  • filename
    Opzionale.Il nome radice del file di sidecar contenente le informazioni di localizzazione per impostazioni cultura.Quando Visual Studio cerca informazioni di localizzazione, tenta di trovare una versione specifiche delle impostazioni cultura del file.Ad esempio, se filename è jquery.xml, Visual Studio cerca nella cartella specifiche delle impostazioni cultura corretta (come JA) nella stessa posizione del file js contenente l'elemento <loc>.Se individuare la cartella specifiche delle impostazioni cultura, controlla se un file di jquery.xml esista in.Se non è possibile individuare il file corretto, ma utilizza le regole di percorso della risorsa gestita.Il valore predefinito per filename è il nome del file corrente, ma con estensione xml anziché js.

  • format
    Opzionale.Il tipo di file di sidecar utilizzato per la localizzazione.Utilizzo messagebundle specificare l'utilizzo dei gruppi del messaggio definito dai metadati Open AJAX.messagebundle è il formato consigliato.Tuttavia, questo formato non è supportato in Microsoft AJAX o in file di .winmd.Utilizzo vsdoc specificare il formato di localizzazione di .NET Framework standard utilizzati da Microsoft Ajax e Windows Runtime.L'attributo è facoltativo.vsdoc è il formato predefinito.

Note

L'elemento <loc> deve trovarsi all'inizio del file nella stessa sezione dell'elemento <reference>.Le regole di utilizzo per l'elemento <loc> sono uguali di elemento <reference>.Per ulteriori informazioni, vedere la sezione “direttive references" in IntelliSense per JavaScript.

Visual Studio genera un singolo elemento <loc> per ogni file js.Se più elementi <loc> sono presenti, solo un singolo elemento <loc> viene utilizzato.Comportamento per determinare quale elemento <loc> da utilizzare non è definito.

Il formato del gruppo di messaggi, utilizzare l'attributo locid nei commenti della documentazione XML per specificare il valore di attributo name.

Esempio

Di seguito viene illustrato come utilizzare l'elemento <loc> con il formato del messagebundle.Aggiungere il seguente codice XML in un file denominato messageFilename.xml e posizionarlo nella cartella specifiche delle impostazioni cultura corretta, come specificato nella descrizione del parametro 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>

Per l'esempio di messagebundle, aggiungere il seguente codice a un file JavaScript nel progetto.L'elemento <loc> deve apparire come prima riga nel file JavaScript.Le descrizioni in questo codice vengono sostituite dalle descrizioni localizzate, se disponibili.

/// <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>
}

Nell'esempio seguente viene utilizzato il formato di VSDoc.Aggiungere il seguente codice XML in un file denominato scriptFilename.xml e posizionarlo nella cartella specifiche delle impostazioni cultura corretta.

<?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>

Per l'esempio di VSDoc, aggiungere il seguente codice a un file JavaScript nel progetto.Le descrizioni in questo codice vengono sostituite dalle descrizioni localizzate, se disponibili.

/// <loc filename="scriptFilename.xml" format="vsdoc" />

function illuminate(a) 
{
    /// <summary locid='M:illuminate'>description</summary>
    /// <param name='a' type='Number'>parameter a description</param>
}

Vedere anche

Concetti

Commenti relativi alla documentazione XML (JavaScript)