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

Comentários de código XML são os comentários de JScript (JavaScript) que podem ser adicionados às funções de script para fornecer um resumo e informações sobre os parâmetros da função e retornar o valor. Em Visual Studio, essas descrições de texto são exibidas com IntelliSense quando você faz referência a função de script.

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

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

• Incluir dentro 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 de 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 IntelliSense

• Digite o nome e o parêntese de abertura de uma função que é marcado com comentários de código XML, como 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 IntelliSense para exibir as informações que são definidas em comentários de código XML.

Consulte também

Tarefas

Demonstra Passo a passo: IntelliSense de JScript

Conceitos

Visão geral de IntelliSense de JScript