ドキュメント コメントを XML ファイルに出力します。
構文
-doc[+ | -]
又は
-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 Studio 統合開発環境で -doc を設定するには |
---|
1. ソリューション エクスプローラーでプロジェクトを選択します。
[プロジェクト] メニューの [プロパティ] をクリックします。 2. [ コンパイル ] タブをクリックします。 3. [ XML ドキュメント ファイルの生成 ] ボックスで値を設定します。 |
例
サンプルについては、「 XML を使用したコードの文書化 」を参照してください。
こちらも参照ください
.NET