次の方法で共有

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 ファイルの作成方法の詳細については、次のトピックをご覧ください。

関連項目