Share via

方法: JavaScript XML ドキュメントのコメントを作成する

  • [アーティクル]

XML ドキュメントのコメント JavaScript のコメント、スクリプト、関数、フィールド、変数などのコード要素に関する情報を提供するために追加されます。スクリプト関数を参照すると Visual Studio では、これらのテキストの説明に IntelliSense が表示されます。

このトピックは、XML ドキュメントのコメントを使用して基本的なチュートリアルを示します。などの他の要素を使用する方法については<var> (JavaScript)と<value> (JavaScript)、およびその他のコード例についてを参照してくださいXML ドキュメント コメント (JavaScript)。などの IntelliSense については、非同期のコールバックを提供することの詳細については、 Promiseを参照してください<returns> (JavaScript)。

[!メモ]

XML ドキュメント コメントは、参照されるファイル、アセンブリ、およびサービスからのみ利用できます。

XML ドキュメントのコメントの JavaScript 関数を作成するのには

  • この関数では、追加<summary> (JavaScript)、 <param> (JavaScript)、および<returns> (JavaScript)要素、各要素には、次の 3 つのスラッシュ (///) よりも前。

    [!メモ]

    各要素は 1 行で必要があります。

    次の例では、JavaScript の関数を示しています。

      function getArea(radius)
  {
      /// <summary>Determines the area of a circle that has the specified 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 * radius * radius;
      return areaVal;
  }

  • XML ドキュメントのコメントを表示するには、名前には、次の例のように、XML ドキュメントのコメントが付いている関数のかっこを入力します。

    var areaVal = getArea(

    XML ドキュメントのコメントが含まれている関数の左かっこを入力すると、コード エディターは、XML ドキュメント コメントで定義されている情報を表示するのに IntelliSense を使用します。

XML ドキュメント コメントは JavaScript を作成するには

  • コンス トラクターの関数またはオブジェクトの定義に追加する、 <field> (JavaScript)要素の前での 3 つのスラッシュ (///)。

    使用例を示します、 <field> 、コンス トラクター関数内の要素。その他の例については、「<field> (JavaScript)」を参照してください。

        function Engine() {
        /// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
        this.HorsePower = 150;
    }

  • XML ドキュメントのコメントを表示するには、マークされている、function コンス トラクターを使用して、次の例のように、XML ドキュメントのコメントをオブジェクトを作成します。

        var eng = new Engine();

  • 次の行には、オブジェクトおよび IntelliSense については、フィールドを表示するには、期間の名前を入力します。

        eng.

XML ドキュメント コメントは、オーバー ロードされた関数を作成するのには

  1. この関数には、追加、 <signature> (JavaScript)要素の各オーバー ロードします。など、他の要素では、これらの要素を追加<summary>、 <param>、および<returns>、前の各要素には、次の 3 つのスラッシュ (///)。

    次の使用例は、オーバー ロードされた JavaScript の関数を示しています。この例では、パラメーターの型でオーバー ロードとは異なります。

        function calc(a) {
        /// <signature>
        /// <summary>Function summary 1.</summary>
        /// <param name="a" type="Number">A number.</param>
        /// <returns type="Number" />
        /// </signature>
        /// <signature>
        /// <summary>Function summary 2.</summary>
        /// <param name="a" type="String">A string.</param>
        /// <returns type="Number" />
        /// </signature>
        return a;
    }

  2. XML ドキュメントのコメントを表示するには、名前には、次の例のように、XML ドキュメントのコメントが付いている関数のかっこを入力します。

        calc(

ローカライズされた IntelliSense を作成するのには

  1. OpenAjax MessageBundle フォーマットでは、ドキュメント コメントを XML ファイルを作成します。

    重要 : 重要

    MessageBundle は、推奨される形式です。この形式では、Microsoft Ajax または .winmd ファイルではサポートされていません。もう 1 つを使用しての詳細についてはVSDocフォーマットは、 <loc> (JavaScript)。

    次の使用例サイドカーファイル ファイルで IntelliSense のローカライズされた情報を含むコンテンツが表示されます。これは、JA など、カルチャに固有のフォルダー内にある XML ファイルです。フォルダーを含む .js ファイルと同じ場所にする必要があります、 <loc>要素。XML ファイルのファイル名と一致する必要があります、 filenameで指定されたパラメーター、 <loc>要素。

    <messagebundle>
  <msg name="1">A class that represents a rectangle</msg>
  <msg name="2">The length of the rectangle</msg>
  <msg name="3">The height of the rectangle</msg>
</messagebundle>

  2. .Js ファイルでは、次のコードを追加します。<loc>要素は、スクリプトの前に宣言する必要あるし、としての同じ使用規則に依存して、 <reference>要素。詳細については、「JavaScript IntelliSense」および「<loc> (JavaScript)」を参照してください。

    /// <loc filename="messageFilename.xml" format="messagebundle"/>

  3. .Js ファイルでは、XML ドキュメントの要素および既定の説明を追加します。設定、 locid属性の値が対応する一致するnameサイドカーファイル ファイルから属性の値。可能な場合、ローカライズされた IntelliSense については、既定の説明に変わります。

    function add(a,b) 
{
    /// <summary locid='1'>description</summary>
    /// <param name='a' locid='2'>parameter a description</param>
    /// <param name='b' locid='3'>parameter b description</param>
}

  4. XML ドキュメントのコメントを表示するには、名前と、次の例のように、関数のかっこを入力します。

    add(

参照

概念

JavaScript IntelliSense

XML ドキュメント コメント (JavaScript)

その他の技術情報

チュートリアル: ASP.NET における JavaScript IntelliSense