Compartir a través de

Cómo: Crear comentarios de código XML JScript

  • Artículo

Los comentarios de código XML son comentarios JScript (JavaScript) que se agregan a las funciones de script para proporcionar un resumen e información sobre los parámetros y el valor devuelto de la función. En Visual Studio, estas descripciones de texto se muestran con IntelliSense cuando hace referencia a la función de script.

Nota

Los comentarios de código XML sólo están disponibles en los archivos, ensamblados y servicios a los que se hace referencia.

Para crear comentarios de código XML para una función de JScript

  • Incluya los elementos summary, param y returns y agregue tres barras diagonales (///) delante de cada elemento.

    Nota

    Los elementos deben estar en una sola línea.

    En el ejemplo siguiente se muestra una función de JScript que incluye cada uno de los tres elementos que se admiten en los comentarios de 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 ver comentarios de código XML utilizando IntelliSense

  • Escriba el nombre y el paréntesis de apertura de una función marcada con comentarios de código XML, como en el ejemplo siguiente:

    var areaVal = areaFunction(

    Al escribir el paréntesis de apertura de la función que contiene los comentarios de código XML, el editor utiliza IntelliSense para mostrar la información definida en dichos comentarios.

Vea también

Tareas

Tutorial: IntelliSense para JScript

Conceptos

Información general de IntelliSense para JScript