Compartilhar via


<summary> (JavaScript)

Especifica a descrição para um método ou função.

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

Parâmetros

  • locid
    Opcional.O identificador de informações de localização sobre a função ou método.O identificador é um membro ID ou ele corresponde do name valor em um pacote de mensagem definido pelos metadados OpenAjax do atributo.O tipo de identificador depende do formato especificado na <loc> (JavaScript) elemento.

  • description
    Opcional.Descrição da função ou método.

Comentários

Os elementos usados para anotar funções que incluem <summary> (JavaScript), <param> (JavaScript), e <returns> (JavaScript), deve ser colocado no corpo da função antes de quaisquer instruções.

Exemplo

O código a seguir mostra como usar o <summary> elemento.

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

Consulte também

Conceitos

Comentários de documentação XML (JavaScript)