MOの気になることを適当に伝えるブログ

moNote

C#

C# - コメント

投稿日:

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

通常のコメント

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);
    }
}

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

-C#
-,

Copyright© moNote , 2020 All Rights Reserved Powered by STINGER.