Compartilhar via


<summary> (JavaScript)

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

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

Parâmetros

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

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

Comentários

Os elementos usados para fazer anotações funções, que incluem <summary> (JavaScript), <param> (JavaScript), e <returns> (JavaScript), devem ser colocados no corpo da função antes de quaisquer declarações.

Exemplo

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

  function areaFunction(radiusParam)
  {
      /// <summary>Determines the area of a circle when supplied a radius parameter.</summary>
      /// <param name="radiusParam" 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)