XML の使用によるコードのドキュメントの作成 (Visual Basic)
Visual Basic では、XML を使用して、コードのドキュメントを作成できます。
XML ドキュメントのコメント
Visual Basic では、プロジェクトの XML ドキュメントを簡単な方法で自動的に作成できます。 型およびメンバーの XML スケルトンを自動的に生成したうえで、概要、各パラメーターの説明ドキュメント、およびその他のコメントを指定できます。 適切なセットアップにより、XML ドキュメントは、プロジェクトと同じ名前に .xml という拡張子を付けた XML ファイルとして自動的に作成されます。 詳細については、「/doc」を参照してください。
この XML ファイルを利用したり、何らかの形で XML として操作することが可能です。 このファイルは、プロジェクトの出力ファイル (.exe ファイルまたは .dll ファイル) と同じディレクトリに配置されます。
XML ドキュメントの先頭は ''' です。 コメントの処理には、次の制限があります。
ドキュメントは、適切な XML であることが必要です。 XML が整形式でない場合、警告が生成され、エラーが発生したことを示すコメントがドキュメント ファイルに記述されます。
開発者は、独自のタグ セットを自由に作成できます。 タグのセットには、推奨のものがあります (このトピックの「関連項目」を参照してください)。 推奨されるタグには、次のような特殊な意味を持つタグがあります。
<param> タグは、パラメーターの記述に使用します。 このタグを使用した場合、コンパイラはパラメーターが存在するかどうか、およびすべてのパラメーターがドキュメントに記述されているかどうかを検査します。 検査に失敗した場合、コンパイラは警告を発行します。
cref 属性をタグに追加すると、コード要素を参照できます。 コンパイラは、このコード要素が存在することを検査します。 検査に失敗した場合、コンパイラは警告を発行します。 また、コンパイラは、cref 属性で指定されている型を検索するときに、Imports ステートメントを考慮に入れます。
<summary> タグは、Visual Studio で型またはメンバーについての追加的な情報を表示するために、IntelliSense によって使用されます。
関連項目
ドキュメント コメントを記述した XML ファイルの作成の詳細については、以下のトピックを参照してください。