Condividi tramite

Procedura: creare commenti di codice XML JScript

  • Articolo

I commenti del codice XML sono commenti JScript (JavaScript) aggiunti alle funzioni di script per fornire un riepilogo e informazioni sui parametri e il valore restituito della funzione. In Visual Studio queste descrizioni di testo vengono visualizzate con IntelliSense quando si fa riferimento alla funzione script.

Nota

I commenti del codice XML sono disponibili solo dai file, dagli assembly e dai servizi a cui viene fatto riferimento.

Per creare commenti di codice XML per una funzione JScript

  • Includere elementi summary, parame returns, ciascuno dei quali preceduto da tre barre (///).

    Nota

    Gli elementi devono essere su una sola riga.

    Nell'esempio seguente viene illustrata una funzione JScript che include ciascuno dei tre elementi ed è supportata nei commenti di codice 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>

Per visualizzare commenti di codice XML utilizzando IntelliSense

  • Digitare il nome e la parentesi di apertura di una funzione contrassegnata da commenti di codice XML, come nell'esempio seguente:

    var areaVal = areaFunction(

    Quando si digita la parentesi di apertura di una funzione contenente commenti di codice XML, l’editor utilizza IntelliSense per visualizzare le informazioni definite in tali commenti.

Vedere anche

Attività

Procedura dettagliata: IntelliSense per JScript

Concetti

Cenni preliminari su IntelliSense per JScript