Практическое руководство. Создание XML-комментариев к коду, написанному на JScript

Обновлен: Ноябрь 2007

Комментарии к коду XML представляют собой комментарии на JScript (JavaScript), добавляемые в функции сценария для обеспечения сводных данных и сведений о параметрах функции и возвращаемом значении. В Visual Studio эти текстовые описания отображаются с IntelliSense при создании ссылки на функцию сценария.

Примечание.
Комментарии к коду XML доступны только из файлов, библиотек и служб со ссылками.

Создание комментариев к коду XML для функции JScript

• В элементы summary, param и returns и перед каждым элементом поставьте три косых черты (///).

  Примечание.
  Элементы должны располагаться на одной строке.

  В следующем примере показана функция JScript с каждым из трех элементов, поддерживаемых в комментариях к коду 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>
  

Просмотр комментариев к коду XML при помощи IntelliSense

• Наберите имя и открывающую круглую скобку функции, помеченной комментариями к коду XML, как показано в следующем примере.

  var areaVal = areaFunction(
  

  После набора открывающей скобки функции с комментариями к коду XML IntelliSense используется в редакторе для отображения сведений, определенных в комментарии к коду XML.

См. также

Задачи

Пошаговое руководство. IntelliSense для JScript

Основные понятия

Общие сведения о IntelliSense для JScript