次の方法で共有


/doc (C# コンパイラ オプション)

/doc オプションを使用すると、XML ファイル内にドキュメント コメントを含めることができます。

/doc:file

引数

  • file
    コンパイルするソース コード ファイル内のコメントが出力される XML 形式の出力ファイル。

解説

ソース コード ファイルでは、次の項目の前にあるドキュメント コメントを処理して、XML ファイルに追加できます。

Main を含むソース コード ファイルが最初に XML に出力されます。

生成された .xml ファイルで IntelliSense 機能を使用するには、サポートするアセンブリの名前と .xml ファイル名を同じにして、そのファイルをアセンブリと同じディレクトリに置いてください。これで、アセンブリが Visual Studio プロジェクトで参照されると、.xml ファイルも同様に検出されます。詳細については、「コード コメントの追加」を参照してください。

/target:module を使用してコンパイルしない限り、file は、コンパイルの出力ファイルのアセンブリ マニフェストを含んでいるファイルの名前を指定する <assembly></assembly> タグを含みます。

[!メモ]

/doc オプションは、すべての入力ファイル (プロジェクトの設定で行った場合は、そのプロジェクト内のすべてのファイル) に適用されます。特定のファイルまたはコードの特定セクションについて、ドキュメントのコメントに関する警告を無効にするには、#pragma warning を使用します。

コードのコメントからドキュメントを生成する方法については、「ドキュメント コメントとして推奨されるタグ」を参照してください。

Visual Studio 開発環境でこのコンパイラ オプションを設定するには

  1. プロジェクトの [プロパティ] ページを開きます。

  2. [ビルド] タブをクリックします。

  3. [XML ドキュメント ファイル] プロパティを変更します。

このコンパイラ オプションをプログラムで設定する方法については、「DocumentationFile」を参照してください。

参照

処理手順

方法 : プロジェクト プロパティおよび構成設定を変更する

その他の技術情報

C# コンパイラ オプション