C#プチリファレンス

C# コメント

C#のコメントの書き方です。

通常のコメント

１行コメントは「//」で始めます。
// これは単一行コメントです。
複数行コメントは「/*」と「*/」で囲みます。
/*
　これは複数行
　コメントです。
*/

ドキュメントコメント

メソッドやクラスにドキュメントコメントを記載しておくと、インテリセンスにドキュメントコメントを表示させることが出来ます。

ドキュメントコメント
/// <summary>
/// ○○メソッド
/// </summary>
/// <param name="Code1">コード１</param>
/// <param name="Code2">コード２</param>
/// <returns>結果</returns>
【ドキュメントコメント】
タグ説明
summaryメソッドの説明を記述する
param引数の説明を記述する
returns戻り値の説明を記述する
example例文　※codeと一緒に使うのが一般的
codeソースコード
exceptionThrowできる例外を指定する
valueプロパティの説明
【例１】
/// <summary>
/// 文字列が半角数値のみかどうかを判定する
/// </summary>
/// <param name="val">対象文字列</param>
/// <returns>結果 True：半角数値のみ　False：半角数値のみではない</returns>
public bool IsHanNumber(string val)
{
  return System.Text.RegularExpressions.Regex.IsMatch(val, @"^[0-9]+$");
}
【例２】
///<exception cref="System.Exception">Exception例外</exception>
【例３】
/// <example> 
/// 例文
/// <code>
/// hoge
/// </code>
/// </example>
【例４】
/// <value>説明</value>
ToTop