/doc
ドキュメント コメントを XML ファイルに出力します。
/doc[+ | -]
' -or-
/doc:file
引数
語句 |
定義 |
+ | - |
省略可能です。 + を指定するか、または /doc だけを指定すると、コンパイラがドキュメント情報を生成し、XML ファイルに出します。 - を指定すると、/doc を指定しないのと同じ意味になり、ドキュメント情報は作成されません。 |
file |
/doc: を使用する場合は、必ず指定します。 コンパイルするソース コード ファイルからコメントを書き込む、XML 形式の出力ファイルを指定します。 ファイル名に空白が含まれる場合は、二重引用符 (" ") で囲む必要があります。 |
解説
/doc オプションを使って、コンパイル時にドキュメント コメントを含む XML ファイルを生成するかどうかを制御できます。 /doc:file の構文を使用する場合、file パラメーターには XML ファイルの名前を指定します。 /doc または /doc+ を使用する場合、コンパイラは作成している実行可能ファイルまたはライブラリから XML ファイル名を取得します。 /doc- を使用するか、または /doc オプションを指定しなければ、コンパイラは XML ファイルを作成しません。
ソース コード ファイルでは、ドキュメント コメントは次の定義の前に記述できます。
生成した XML ファイルを Visual Studio の IntelliSense 機能で使用するには、XML ファイルの名前をサポートするアセンブリの名前と同じにします。 XML ファイルをアセンブリと同じディレクトリに格納して、アセンブリが Visual Studio プロジェクトで参照されるとき、.xml ファイルも同時に見つかるようにしてください。 IntelliSense がプロジェクト内のコード、またはプロジェクトによって参照されるプロジェクト内のコードを処理するために、XML ドキュメント ファイルは必要ありません。
/target:module を使ってコンパイルしなければ、XML ファイルにはタグ <assembly></assembly> が記述されます。 これらのタグは、コンパイルによる出力ファイルのアセンブリ マニフェストを含むファイル名を指定します。
コード内のコメントからドキュメントを生成する方法については、「ドキュメント コメントとして推奨される XML タグ (Visual Basic)」を参照してください。
Visual Studio 統合開発環境で /doc を設定するには |
|
使用例
具体的な例については、「XML の使用によるコードのドキュメントの作成 (Visual Basic)」を参照してください。
参照
概念
XML の使用によるコードのドキュメントの作成 (Visual Basic)