HOW TO：建立 JScript XML 程式碼註解

XML 程式碼註解是可加入指令碼函式的 JScript (JavaScript) 註解，以提供摘要以及與函式參數和傳回值相關的資訊。 在 Visual Studio 中，這些文字描述會在您參考指令碼函式時，與 IntelliSense 一起顯示。

注意事項
XML 程式碼註解僅能從參考的檔案、組件和服務取得。

若要建立 JScript 函式的 XML 程式碼註解

• 在 include 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>
  

若要使用 IntelliSense 檢視 XML 程式碼註解

• 輸入標記有 XML 程式碼註解的函式名稱和左括號，如下範例所示：

  var areaVal = areaFunction(
  

  輸入包含 XML 程式碼註解之函式的左括號時，編輯器就會使用 IntelliSense 顯示在 XML 程式碼註解中定義的資訊。

請參閱

工作

逐步解說：JScript IntelliSense

概念

JScript IntelliSense 概觀