Aracılığıyla paylaş


<loc> (JavaScript)

Yerelleştirilmiş IntelliSense bilgilerinin sağlar sepet dosya türünü ve konumunu belirtir.

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

Parametreler

  • filename
    İsteğe Bağlı.Bağımsız kültür için yerelleştirme bilgisi içeren sepet dosyası kök adı.Visual Studio için yerelleştirme bilgisi arama yaptığında, bu dosyayı kültür özgü sürümünü bulmaya çalışır.Örneğin, filename jquery.xml, Visual Studio arar (ja gibi) doğru kültür özel klasörü içeren .js dosya ile aynı konumda olan <loc> öğesi.Kültür özel klasör bulur, bir jquery.xml dosyası içinde var olup olmadığını denetler.Doğru dosyayı bulamıyorsanız, bunun yerine yönetilen kaynak konumu kuralları kullanır.Varsayılan değeri filename .js yerine .xml uzantısıyla ancak geçerli dosyanın adıdır.

  • format
    İsteğe Bağlı.Yerelleştirme için kullanılan sepet dosyası türü.Kullanmak messagebundle açık Ajax meta verileri tarafından tanımlanan ileti paketleri belirtmek için.messagebundleönerilen biçimdir.Ancak, bu biçim, Microsoft Ajax ya da .winmd dosyaları desteklenmiyor.Use vsdoc Microsoft Ajax ve Windows çalışma zamanı tarafından kullanılan standart .net Framework yerelleştirme biçimi belirtmek için.Bu öznitelik isteğe bağlıdır.vsdocVarsayılan biçimidir.

Notlar

<loc> Gerekir görünür dosyası aynı bölümünde üst öğe <reference> öğesi.Kullanım kuralları için <loc> öğe ile aynı olan <reference> öğesi."Başvuruları yönergeleri" bölümünde daha fazla bilgi için bkz: JavaScript IntelliSense.

Visual Studio'nun tek bir işler <loc> her .js dosya öğesi.Birden fazla ise <loc> öğeler varsa, yalnızca tek bir <loc> öğesi kullanılır.Hangi belirlemek için davranış <loc> öğesini kullanmak için tanımlı değil.

İleti paket biçimi kullanırken kullanma locid belirlemek için xml belgesi açıklamalarının özniteliğinde name öznitelik değeri.

Örnek

Aşağıdaki örnek, nasıl kullanılacağını gösterir <loc> messagebundle biçimi olan öğe.Aşağıdaki xml messageFilename.xml adlı bir dosya ekleyin ve dosyanın açıklamasını belirtildiği gibi doğru kültür özgü klasörüne yerleştirin filename parametresi.

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

Messagebundle Örneğin, projenizde bir JavaScript dosyası aşağıdaki kodu ekleyin.<loc> Öğesi gerekir JavaScript dosyasındaki ilk satır olarak görünür.Bu kod yer alan açıklamalar varsa yerelleştirilmiş açıklamalarına göre değiştirilecektir.

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

Aşağıdaki örnek, VSDoc biçimi kullanır.Aşağıdaki xml scriptFilename.xml adlı bir dosya ekleyin ve dosyanın doğru kültür özgü klasörüne yerleştirin.

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

VSDoc Örneğin, projenizde bir JavaScript dosyası aşağıdaki kodu ekleyin.Bu kod yer alan açıklamalar varsa yerelleştirilmiş açıklamalarına göre değiştirilecektir.

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

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

Ayrıca bkz.

Kavramlar

xml belgesi açıklamalarının (JavaScript)