Sdílet prostřednictvím


<loc> (JavaScript)

Určuje umístění a typ souboru přívěsného vozíku, lokalizované informace technologie IntelliSense.

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

Parametry

  • filename
    Nepovinné.Název kořenového adresáře, souboru přívěsného vozíku, který obsahuje informace o lokalizaci pro neutrální jazykovou verzi.Visual Studio hledá informace o lokalizaci, pokusí najít specifické verzi tohoto souboru.Například pokud filename jquery.xml vyhledá správné specifické složky (jako JA) do stejného umístění jako soubor JS, obsahující Visual Studio je <loc> prvku.Vyhledá specifické složky, kontroluje zda v ní existuje soubor jquery.xml.Pokud nelze najít správný soubor, místo toho používá pravidla umístění spravovaného prostředku.Výchozí hodnota pro filename je název souboru, ale s příponou XML místo js.

  • format
    Nepovinné.Typ souboru přívěsného vozíku pro lokalizaci.Použít messagebundle -li používat svazky zprávu otevřít Ajax metadat definované.messagebundleje doporučený formát.Tento formát však není podporován v Microsoft Ajax nebo .winmd soubory.Použití vsdoc určit standardní formát lokalizace rozhraní.NET Framework používaný Microsoft Ajax a Runtime v systému Windows.Tento atribut je volitelný.vsdocje výchozí formát.

Poznámky

<loc> Prvku musí být na začátku souboru ve stejném oddílu jako <reference> prvku.Pravidla používání <loc> prvku jsou stejné jako <reference> prvku.Další informace naleznete v části "Směrnic odkazy" JavaScript IntelliSense.

Visual Studio zpracovává jeden <loc> prvek pro každý soubor JS.Pokud je více <loc> prvky jsou k dispozici, pouze jediný <loc> použití prvku.Chování pro určení <loc> není definován prvek použít.

Při použití formátu svazku, použít locid komentářů dokumentace XML zadat atribut name hodnotu atributu.

Příklad

Následující příklad ukazuje použití <loc> prvku messagebundle formátu.Přidejte následující kód XML do souboru s názvem messageFilename.xml a umístěte soubor do správné složky specifické podle popisu filename parametr.

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

Například messagebundle přidejte následující kód do souboru JavaScriptu v projektu.<loc> Prvku musí být uvedeny jako první řádek v souboru JavaScriptu.Popisy tohoto kodexu bude nahrazen lokalizované popisy, pokud je k dispozici.

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

Následující příklad používá formát VSDoc.Přidejte následující kód XML do souboru s názvem scriptFilename.xml a ve správné složce specifické umístění souboru.

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

Například VSDoc přidejte následující kód do souboru JavaScriptu v projektu.Popisy tohoto kodexu bude nahrazen lokalizované popisy, pokud je k dispozici.

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

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

Viz také

Koncepty

Komentáře XML dokumentace (JavaScript)