C#でregionを使って長いソースを折りたたむ方法

ソースコードが長くなった時に、可読性を上げるために使うべきなのが「region」と呼ばれるものです。Visual Studioでソースコードを記述するときにコードを折りたたんで表示してくれる機能です。

regionの使い方、使うべきポイントについて、この記事では解説していきます。使いすぎるのはあまり良くない機能ですが、しっかりとポイントを押さえて使えば可読性があがりますし、便利な機能なので覚えておくとよいと思います。

regionの使い方

「region」は正式名称で「regionディレクティブ」と呼ばれています。口頭では単に「リージョン」って言っていることが多いです。使い方はとっても簡単で、折りたたんで表示したいソースコードを「#region」「#endregion」で囲むだけです。

「#region」の後にスペースを追加してコメントを記述することができます。例えば「#region 〇〇」というように使用することができます。以下のコードをサンプルとします。

namespace App22
{
    public class Car
    {
        private string Name;

        #region Constructor
        public Car()
        {

        }
        #endregion

        #region Public methods
        public void Drive()
        {

        }

        public void Brake()
        {

        }
        #endregion
    }
}

上記のように記述した場合は以下のようにVisual Studio上で表示され、コードが折りたたまれて表示されます。適宜、種類ごとに分けたり、コンストラクタやメソッドなどを区切るために使用したりするようにすると良いでしょう。

メソッド内でregionを使ってしまうとソースコードの全量がわかりづらくなるため、メソッド内では使わないようにしましょう。以下のように使用するのは、折り畳まれているソース量が分かりづらくなるので避けるのがよいです。

namespace App22
{
    public class Car
    {
        private string Name;

        #region Constructor
        public Car()
        {
            #region Write message
            Console.WriteLine("走ります。");
            #endregion
        }
        #endregion

        #region Public methods
        public void Drive()
        {

        }

        public void Brake()
        {

        }
        #endregion
    }
}

とはいえregionを使用することで、ソースコードが長くなってしまった場合に、ファイル内を整理することができるのでVisual Studioを使用している場合は有益だと感じています。ところかまわず使用するのではなく、メリハリをつけて使用すると便利な機能です。