C# - コメント

投稿日：2020/09/10

プログラム言語を勉強する時はまずコメントから！

通常のコメント

1行コメント「//」で始めます。

// コメント

複数行コメント（ブロックコメント）は「 /* 」と「 */ 」で囲みます。

/*
   複数行の
    コメント
*/

ドキュメントコメント

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

ドキュメントコメントを認識させるにはクラスやメソッドのまえで「///」と入力してEnterを押します。

class Test
{
    public void TestPrint(String s)
    {
        Console.WriteLine(s);
    }
}

「///」を入力してEnterを押すと

/// <summary>
/// 
/// </summary>
class Test
{
    /// <summary>
    /// 
    /// </summary>
    /// <param name="s"></param>
    public void TestPrint(String s)
    {
        Console.WriteLine(s);
    }
}

この 1～3行目と 6～9行目がドキュメントコメントになります。

作成されたタグには以下のような意味があります。

タグ	対象	説明
<summary>	メンバ	「概要」
<param>	メソッド	「引数」の説明

他にも色々なタグがあり、追記するこでインテリセンスで利用できます。

/// <summary>
/// テスト用のクラス
/// </summary>
class Test
{
    /// <summary>
    /// テスト用のメソッド
    /// </summary>
    /// <param name="s">表示させたい文字列</param>
    public void TestPrint(String s)
    {
        Console.WriteLine(s);
    }
}

上記のように記入すると、次のように表示されます。