-doc

  • [アーティクル]

ドキュメント コメントを XML ファイルに出力します。

構文

-doc[+ | -]

or

-doc:file

引数

期間 定義
+ | - 任意。 +、または単に -doc を指定すると、コンパイラによってドキュメント情報が生成され、XML ファイル内に置かれます。 - を指定することは -doc を指定しないことと同じで、この場合ドキュメント情報は作成されません。
file -doc: を使用する場合に、必ず指定します。 出力の XML ファイルを指定します。これにはコンパイルのソース コード ファイルからのコメントが入力されます。 ファイル名に空白が含まれている場合は、名前を引用符 (" ") で囲みます。

Remarks

-doc オプションでは、コンパイラにドキュメント コメントを含む XML ファイルを生成させるかどうかを制御できます。 -doc:file 構文を使用する場合、file パラメーターによって XML ファイルの名前を指定します。 -doc または -doc+ を使用する場合、コンパイラは、コンパイラが作成中の実行可能ファイルまたはライブラリから XML ファイルの名前を取得します。 -doc- を使用する場合、または -doc オプションを指定しない場合、コンパイラは XML ファイルを作成しません。

ソース コード ファイルで、ドキュメント コメントを次の定義の前に置くことができます。

Visual Studio IntelliSense 機能で生成された XML ファイルを使用するには、XML ファイルの名前をサポートするアセンブリの名前と同じにします。 Visual Studio プロジェクトでアセンブリが参照されたときに .xml ファイルがうまく見つかるようにするために、XML ファイルがアセンブリと同じディレクトリにあることを確認します。 IntelliSense をプロジェクト内のコード、またはプロジェクトに参照されるプロジェクト内のコードに対して動作させるために、XML ドキュメント ファイルは必須ではありません。

-target:module を使用してコンパイルしない限り、XML ファイルにはタグ <assembly></assembly> が含まれます。 これらのタグでは、コンパイルの出力ファイルに向けたアセンブリ マニフェストを含むファイルの名前が指定されます。

コード内のコメントからドキュメントを生成する方法については、「XML のコメント用タグ」をご覧ください。

Visual Studio 統合開発環境で -doc を設定するには
1. ソリューション エクスプローラーでプロジェクトを選択します。 [プロジェクト] メニューの [プロパティ] をクリックします。
2. [コンパイル] タブをクリックします。
3. [XML ドキュメント ファイルを生成する] ボックスに値を設定します。

例

サンプルについては、「XML の使用によるコードのドキュメントの作成」をご覧ください。

関連項目