コーディング規約 トップページ > C# コーディング規約 目次

1.9 XMLドキュメントコメント

XMLドキュメントコメントからコメントを抜き出すために、下記のようなコメント形式にも対応している。
メソッドのXMLドキュメントコメントは、<summary>,<param>などの全てのタグに対応している。
変数、定数、InterfaceなどのXMLドキュメントコメントは、<summary>のみ対応している。
XMLの構文エラーの場合は、ドキュメントに出力されない。

■XMLドキュメントコメントの例

　/// <summary>
　///　XMLドキュメントコメントの説明を出力します。
　///　以下のタグはコメントを抽出できます。
　/// </summary>
　/// <remarks>
　///　機能説明はこのように記述します。
　/// </remarks>
　/// <param name="Coumment">出力コメント文字列</param>
　/// <param name="Size">出力コメントサイズ</param>
　/// <returns>
　///　返り値はこのように記述します。
　/// </returns>
　/// <exception>
　///　例外処理はこのように記述します。
　/// </exception>
　private void WebPageBuildComment(string Coumment, int Size)
　{
　}

　/// <summary>
　/// ループの数
　/// </summary>
　public const int LOOP_COUNT = 2;

　/// <summary>
　/// ボタンのサイズ
　/// </summary>
　public static int nSize = 10;

　/// <summary>
　/// interfaceコメント
　/// </summary>
　public interface InterSample
　{
　　event MyDelegate MyEvent1; // MyEvent1コメント
　　event MyDelegate MyEvent2; // MyEvent2コメント
　}

　/// <summary>
　/// structコメント
　/// </summary>
　public struct PERSON
　{
　　string Name; 　// 名前
　　int Age; 　　　 // 年齢
　}

　/// <summary>
　/// enumコメント
　/// </summary>
　public enum WeekDay
　{
  　Sun = 1,　　// 日曜日
  　Mon = 2,　　// 月曜日
  　Tue = 3,　　// 火曜日
  　Wed = 4,　 // 水曜日
  　Thu = 5,　 // 木曜日
  　Fri = 6,　　// 金曜日
  　Sat = 7,　 // 土曜日
　}

　/// <summary>
　/// delegateコメント
　/// </summary>
　public delegate void MyDelegate(int i);