Share via


方法 : Visual Basic で XML ドキュメントを作成する

この例は、XML ドキュメントのコメントをコードに追加する方法を示しています。

注意

お使いのマシンで、Visual Studio ユーザー インターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。 これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。 詳細については、「Visual Studio の設定」を参照してください。

型またはメンバーに対して XML ドキュメントを作成するには

  1. コード エディターで、ドキュメントを作成する対象の型またはメンバーの上の行にカーソルを置きます。

  2. ''' (3 つの単一引用符) を入力します。

    型またはメンバーに対する XML スケルトンがコード エディターに追加されます。

  3. 適切なタグの間に説明情報を追加します。

    注意

    XML ドキュメント ブロック内に行を追加した場合、各行の先頭は ''' である必要があります。

  4. XML ドキュメントの新しいコメントを指定した型またはメンバーを使用するコードを追加します。

    IntelliSense により、当該の型またはメンバーに対する <summary> タグのテキストが表示されます。

  5. コードをコンパイルし、ドキュメントのコメントを含む XML ファイルを生成します。 詳細については、「/doc」を参照してください。

参照

参照

ドキュメント コメントとして推奨される XML タグ (Visual Basic)

/doc

概念

XML の使用によるコードのドキュメントの作成 (Visual Basic)