Comment : créer des commentaires de code XML JScript

Les commentaires de code XML sont des commentaires JScript (JavaScript) que vous pouvez ajouter aux fonctions de script pour fournir un résumé et donner des informations sur les paramètres et la valeur de retour d'une fonction. Dans Visual Studio, ces descriptions de texte sont affichées avec IntelliSense lorsque vous référencez la fonction de script.

Note

Les commentaires de code XML sont uniquement disponibles dans les fichiers, les assemblys et les services référencés.

Pour créer des commentaires de code XML pour une fonction JScript

  • Incluez les éléments summary, param et returns en faisant précéder chacun d'eux de trois barres obliques (///).

    Note

    Les éléments doivent figurer sur une seule ligne.

    L'exemple suivant illustre une fonction JScript qui inclut chacun des trois éléments pris en charge dans les commentaires de code 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>
    

Pour afficher des commentaires de code XML à l'aide d'IntelliSense

  • Tapez le nom et la parenthèse ouvrante d'une fonction marquée avec des commentaires de code XML, comme dans l'exemple suivant :

    var areaVal = areaFunction(
    

    Lorsque vous tapez la parenthèse ouvrante de la fonction qui contient les commentaires de code XML, l'éditeur utilise IntelliSense pour afficher les informations définies dans les commentaires de code XML.

Voir aussi

Tâches

Procédure pas à pas : JScript IntelliSense

Concepts

Vue d'ensemble de JScript IntelliSense