Freigeben über


<summary> (JavaScript)

Gibt die Beschreibung für eine Funktion oder Methode.

<summary locid="descriptionID">description</summary>

Parameter

  • locid
    Dies ist optional.Der Bezeichner für die von Lokalisierungsinformationen über die Funktion oder Methode.Der Bezeichner ist entweder ein Produkt-ID oder es entspricht der name Attributwert im Bundle Nachricht durch OpenAjax-Metadaten definiert.Der Typ des Bezeichners im angegebenen Format hängt von der <loc> (JavaScript) Element.

  • description
    Dies ist optional.Eine Beschreibung der Funktion oder Methode.

Hinweise

Die Elemente zum Kommentieren von Funktionen, darunter verwendet <summary> (JavaScript), <param> (JavaScript), und <returns> (JavaScript), muss sich in den Rumpf der Funktion vor allen Anweisungen.

Beispiel

Der folgende Code veranschaulicht die <summary> Element.

  function areaFunction(radiusParam)
  {
      /// <summary>Determines the area of a circle when supplied a 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 * radiusParam * radiusParam;
      return areaVal;
  }

Siehe auch

Konzepte

XML-Dokumentationskommentare (JavaScript)