プロジェクトでオブジェクトとインターフェイスを定義したら、コード コメント Web レポートを使用することにより、定義したオブジェクト、インターフェイス、およびメンバの構造を表示できます。これらのレポートには、コード内の定義に関する情報が一連の .htm ページで表示されます。C#、または XML ドキュメント コメントをサポートするその他の言語を使用する場合は、XML ドキュメント コメントを使用して、概要情報、定義内容の動作に関する詳細な注釈、関数に渡すパラメータの概要を表示できます。
メモ Visual C++ では、XML ドキュメント コメントが制限付きでサポートされています。
コード コメント Web レポートでは、次の XML タグが認識されます。
- <summary></summary> 型のメンバについて説明します。
- <remarks></remarks> クラスやその他の型についての概要情報を示します。
- <param></param> メソッド宣言のコメント内で使用され、メソッドのパラメータの 1 つについて説明します。
- <returns></returns> メソッド宣言のコメント内で使用され、戻り値について説明します。
- <newpara></newpara> コメント内で新しい段落を開始します。
詳細については、「ドキュメント コメントのタグ」を参照してください。
参照
C# コードへのコメントの追加 | コメントによるコード構造の表示 | [Web ページのビルド コメント] ダイアログ ボックス | ドキュメント コメントのタグ