次の方法で共有

XML を使用してコードを文書化する (Visual Basic)

Visual Basic では、XML を使用してコードを文書化できます。

XML ドキュメント コメント

Visual Basic では、プロジェクトの XML ドキュメントを自動的に作成する簡単な方法が提供されます。 型とメンバーの XML スケルトンを自動的に生成し、概要、各パラメーターの説明ドキュメント、およびその他の解説を提供できます。 適切なセットアップにより、XML ドキュメントはプロジェクトと同じルート ファイル名を持つ XML ファイルに自動的に出力されます。 XML ドキュメント ファイルの生成の構成については、 -doc コンパイラ オプション と GenerateDocumentationFile MSBuild プロパティを参照してください。

XML ファイルは、使用することも、XML として操作することもできます。 このファイルは、プロジェクトの出力 .exe または .dll ファイルと同じディレクトリにあります。

XML ドキュメントは、 '''から始まります。 これらのコメントの処理には、いくつかの制限があります。

  • ドキュメントは整形式の XML である必要があります。 XML が整形式でない場合は、警告が生成され、エラーが発生したことを示すコメントがドキュメント ファイルに含まれています。

  • 開発者は、独自のタグのセットを自由に作成できます。 推奨されるタグのセットがあります ( XML コメント タグを参照)。 推奨されるタグの一部には特別な意味があります。

    • パラメーターを記述するには、 <param> タグを使用します。 使用した場合、コンパイラはパラメーターが存在し、すべてのパラメーターがドキュメントで説明されていることを確認します。 検証が失敗した場合、コンパイラは警告を発行します。

    • cref 属性は任意のタグにアタッチでき、コード要素への参照を提供します。 コンパイラは、このコード要素が存在することを確認します。 検証が失敗した場合、コンパイラは警告を発行します。 コンパイラは、cref属性で記述されている型を探すときに、Importsステートメントも考慮します。

    • <summary> タグは、型またはメンバーに関する追加情報を表示するために Visual Studio の IntelliSense によって使用されます。

ドキュメント コメントを含む XML ファイルの作成の詳細については、次のトピックを参照してください。

こちらも参照ください