Compartilhar via

Como: Criar comentários de código de JScript XML

  • Artigo

Comentários de código XML são comentários JScript (JavaScript) que você adicionar a funções de script para fornecer um resumo e as informações sobre parâmetros da função e retornar o valor.In Visual Studio, essas descrições de texto são exibidas com o IntelliSense ao fazer referência a função de script.

Observação:

Comentários de código XML estão disponível somente de arquivos referenciados, assemblies e serviços.

Para criar comentários de código XML para uma função JScript

  • Incluir dentro de summary, param, e returns elementos e preceder cada elemento com três barras (/ / /).

    Observação:

    Os elementos devem estar em uma única linha.

    O exemplo a seguir mostra uma função JScript que inclui cada um dos três elementos que é suportado nos comentários do código XML.

    <script type="text/javascript">
  function areaFunction(radiusParam)
  {
      /// <summary>Determines the area of a circle based on 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;
  }
</script>

Para exibir o código XML comentários usando o IntelliSense

  • Digite o nome e o parêntese de abertura de uma função que é marcado com comentários de código XML, sistema autônomo no exemplo a seguir:

    var areaVal = areaFunction(

    Quando você digita o parêntese de abertura da função que contém os comentários de código XML, o editor usa o IntelliSense para exibir as informações que são definidas em comentários do código XML.

Consulte também

Tarefas

Demonstra Passo a passo: JScript IntelliSense

Conceitos

Visão geral do JScript IntelliSense