Nasıl: JavaScript xml belgelerine açıklamaları oluşturma

Makale
02/26/2013

xml belgesi açıklamalarının JavaScript kodu öğeleri gibi işlevler, alanlar ve değişkenleri hakkında bilgi sağlamak için bir komut dosyası eklemek yorum olduğunu. Komut dosyası işlev başvuru yaptığınızda Visual Studio IntelliSense ile bu metin açıklamaları görüntülenir.

Bu konu, temel bir eğitim kullanarak xml belgeleri açıklamalar sağlar. Gibi diğer öğeleri kullanma hakkında daha fazla bilgi için <var> (JavaScript) ve <value> (JavaScript)ve ek kod örnekleri için bkz: xml belgesi açıklamalarının (JavaScript). Zaman uyumsuz bir geri arama için IntelliSense bilgilerinin gibi sağlama hakkında bilgi için bir Promise, bkz: <returns> (JavaScript).

Not

xml belgesi açıklamalarının yalnızca başvurulan dosyalar, Derlemeler ve Hizmetleri.

xml belgeleri oluşturmak için bir JavaScript işlevi için yorumlar

İşlev Ekle <summary> (JavaScript), <param> (JavaScript), ve <returns> (JavaScript) öğeleri ve her öğe üç eğik çizgi işareti (/ /) koyun.

Not

Her öğeyi tek bir satırda olmalıdır.

Aşağıdaki örnek, bir JavaScript işlevi gösterir.

  function getArea(radius)
  {
      /// <summary>Determines the area of a circle that has the specified radius parameter.</summary>
      /// <param name="radius" type="Number">The radius of the circle.</param>
      /// <returns type="Number">The area.</returns>
      var areaVal;
      areaVal = Math.PI * radius * radius;
      return areaVal;
  }

xml belgeleri açıklamaları görüntülemek için adı ve parantez aşağıdaki örnekte olduğu gibi xml belgeleri açıklamalar ile işaretlenmiş işlevi yazın:
```
var areaVal = getArea(
```
Parantez içeren xml belgesi açıklamalarının işlevinin yazdığınızda, Code Editor IntelliSense xml belgelerine açıklamalarda tanımlanan bilgileri görüntülemek için kullanır.

xml belgeleri oluşturmak için bir JavaScript alan için yorumlar

Bir yapıcı işlevi veya nesnesi tanımında eklemek bir <field> (JavaScript) öğesi tarafından üç eğik çizgi işareti (/ /) koyarak.

Aşağıdaki örnek kullanımını gösterir <field> öğesinde bir yapıcı işlevi. Ek örnekler için bkz. <field> (JavaScript).
```
    function Engine() {
        /// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
        this.HorsePower = 150;
    }
```
xml belgeleri açıklamaları görüntülemek için aşağıdaki örnekte olduğu gibi xml belgeleri açıklamalar ile işaretlenmiş işlevi Oluşturucu kullanarak bir nesne oluşturun.
```
    var eng = new Engine();
```
Sonraki satırda, nesne ve alan için IntelliSense bilgi göstermek için bir dönem adını yazın.
```
    eng.
```

xml belgeleri oluşturmak için bir işlevde yorumu

İşlev Ekle bir <signature> (JavaScript) her aşırı öğesi. Bu öğeleri gibi diğer öğeleri ekleme <summary>, <param>, ve <returns>, önceki üç eğik çizgi işareti (/ /) her öğe.

Aşırı yüklü bir JavaScript işlevi aşağıdaki örnekte gösterilmektedir. Bu örnekte, aşırı parametre türüne göre farklılık gösterir.

    function calc(a) {
        /// <signature>
        /// <summary>Function summary 1.</summary>
        /// <param name="a" type="Number">A number.</param>
        /// <returns type="Number" />
        /// </signature>
        /// <signature>
        /// <summary>Function summary 2.</summary>
        /// <param name="a" type="String">A string.</param>
        /// <returns type="Number" />
        /// </signature>
        return a;
    }

xml belgeleri açıklamaları görüntülemek için adı ve parantez aşağıdaki örnekte olduğu gibi xml belgeleri açıklamalar ile işaretlenmiş işlevi yazın:
```
    calc(
```

Yerelleştirilmiş IntelliSense oluşturmak için

OpenAjax MessageBundle biçiminde belgeleme yorumları içeren bir xml dosyası oluşturun.

Önemli

MessageBundle önerilen biçimdir.Bu biçim, Microsoft Ajax veya .winmd dosyaları desteklenmiyor.Alternatif kullanma hakkında daha fazla bilgi için VSDoc biçimlendirmek için bkz: <loc> (JavaScript).

Aşağıdaki örnek, yerelleştirilmiş IntelliSense bilgileri içeren bir sepet dosyası içerik gösterir. Bu gibi ja, özel kültür klasöründe bulunan bir xml dosyasıdır. Klasörü içeren .js dosya ile aynı konumda olmalıdır <loc> öğesi. xml dosyasının dosya adı eşleşmelidir filename parametresi tarafından belirtilen <loc> öğesi.
```
<messagebundle>
  <msg name="1">A class that represents a rectangle</msg>
  <msg name="2">The length of the rectangle</msg>
  <msg name="3">The height of the rectangle</msg>
</messagebundle>
```
.Js dosyanıza aşağıdaki kodu ekleyin. <loc> Öğesi komut dosyaları önce bildirilmelidir ve aynı kullanım olarak kurallara <reference> öğesi. Daha fazla bilgi için, bkz. JavaScript IntelliSense ve <loc> (JavaScript).
```
/// <loc filename="messageFilename.xml" format="messagebundle"/>
```
xml belgeleri öðeler ve varsayılan açıklamaları .js dosyanıza ekleyin. Set locid öznitelik değerlerine karşılık gelen eşleştirmek için name sepet dosyasından öznitelik değerleri. Kullanılabilir durumdaysa, varsayılan açıklamaları yerelleştirilmiş IntelliSense bilgilerinin tarafından değiştirilecektir.
```
function add(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>
}
```
xml belgeleri açıklamaları görüntülemek için adı ve parantez işlevinin aşağıdaki örnekte olduğu gibi yazın:
```
add(
```

Ayrıca bkz.

Kavramlar

JavaScript IntelliSense

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

Diğer Kaynaklar

İzlenecek yol: JavaScript IntelliSense ASP.NET

Aracılığıyla paylaş