Porady: tworzenie komentarzy do dokumentacji JavaScript XML

Artykuł
06/10/2015

Komentarzy dokumentacji XML są JavaScript komentarze dodawane do skryptu, informacje o elementy kodu, takie jak funkcje, pól i zmiennych.W programie Visual Studio te opisy tekstowe są wyświetlane za pomocą technologii IntelliSense podczas odwołania do funkcji skryptów.

Ten temat zawiera podstawowe samouczek za pomocą komentarzy dokumentacji XML.Informacji o korzystaniu z innych elementów, takich jak <var> (JavaScript) i <value> (JavaScript)i przykłady kodu dodatkowych, zobacz Komentarze dokumentacji XML (JavaScript).Na temat takich jak technologia IntelliSense informacji dla asynchroniczna informacji Promise, zobacz <returns> (JavaScript).

[!UWAGA]

Komentarzy dokumentacji XML są dostępne tylko z plików, zespoły i usług.

Aby utworzyć komentarzy dokumentacji XML dla funkcji JavaScript

W funkcji, należy dodać <summary> (JavaScript), <param> (JavaScript), i <returns> (JavaScript) elementów i poprzedzić każdego elementu z trzech znaków ukośnika (/ / /).

[!UWAGA]

Każdy element musi być w jednym wierszu.

W poniższym przykładzie funkcja JavaScript.

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

Do przeglądania komentarzy dokumentacji XML, wpisz nazwę i nawias otwierający, funkcji, która jest oznaczona za pomocą komentarzy dokumentacji XML, jak w poniższym przykładzie:
```
var areaVal = getArea(
```
Po wpisaniu funkcji, która zawiera komentarzy dokumentacji XML nawias otwierający, Edytor kodu używa technologii IntelliSense do wyświetlania informacji o zdefiniowanym w komentarzy dokumentacji XML.

Aby utworzyć komentarzy dokumentacji XML dla pola JavaScript

W definicji funkcji lub obiekt konstruktora, dodać <field> (JavaScript) element poprzedzone trzy znaki ukośnika (/ / /).

Poniższy przykład przedstawia wykorzystanie <field> element w funkcji konstruktora.Dodatkowe przykłady, zobacz <field> (JavaScript).
```
    function Engine() {
        /// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
        this.HorsePower = 150;
    }
```
Do przeglądania komentarzy dokumentacji XML, należy utworzyć obiekt przy użyciu funkcji konstruktora, oznaczony za pomocą komentarzy dokumentacji XML, jak w poniższym przykładzie.
```
    var eng = new Engine();
```
W następnym wierszu wpisz nazwę obiektu i okres, aby pokazać informacje IntelliSense dla pola.
```
    eng.
```

Aby utworzyć komentarzy dokumentacji XML dla przeciążonej funkcji

W funkcji, należy dodać <signature> (JavaScript) element dla każdego przeciążenie.W tych elementów, Dodaj inne elementy, takie jak <summary>, <param>, i <returns>, poprzedzających każdy element z trzech ukośniki (/ / /).

Poniższy przykład pokazuje przeciążonej funkcji JavaScript.W tym przykładzie overloads różnią się o typ parametru.

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

Do przeglądania komentarzy dokumentacji XML, wpisz nazwę i nawias otwierający funkcji oznaczone komentarzy dokumentacji XML, jak w poniższym przykładzie:
```
    calc(
```

Aby utworzyć zlokalizowane IntelliSense

Utwórz plik XML, który zawiera komentarzy dokumentacji w formacie OpenAjax MessageBundle.

Ważne
MessageBundle jest zalecany.Ten format nie jest obsługiwany, Ajax firmy Microsoft lub w plikach .winmd.Informacji o korzystaniu z ewentualnie VSDoc formatowania, zobacz <loc> (JavaScript).

Poniższy przykład przedstawia zawartość w pliku pomocniczym, zawierającą zlokalizowane informacje IntelliSense.Jest to plik XML, który znajduje się w folderze kultury, takich jak JA.Folder musi być w tej samej lokalizacji co plik js, który zawiera <loc> element.Nazwa pliku w pliku XML musi odpowiadać filename parametr <loc> element.

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

W pliku js Dodaj następujący kod.<loc> Element musi być zgłoszona przed dowolnego skryptu i tej samej reguły użycia jako <reference> element.Aby uzyskać więcej informacji, zobacz JavaScript IntelliSense i <loc> (JavaScript).
```
/// <loc filename="messageFilename.xml" format="messagebundle"/>
```
W pliku js Dodawanie elementów dokumentacji XML i opisy domyślne.Ustaw locid wartości do odpowiedniego atrybutu name wartości atrybutu z pliku pomocniczym.Opisy domyślne zostaną zastąpione zlokalizowane informacje IntelliSense, jeżeli jest dostępny.
```
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>
}
```
Do przeglądania komentarzy dokumentacji XML, wpisz nazwę i nawias otwierający, funkcji, jak w poniższym przykładzie:
```
add(
```

Zobacz też

Koncepcje

JavaScript IntelliSense

Komentarze dokumentacji XML (JavaScript)

Inne zasoby

Instruktaż: Technologia JavaScript IntelliSense w programie ASP.NET

Udostępnij za pośrednictwem