【C#】コメントをソースコードに書く方法

コーディングを行って暫くして、いざ開発したソースコードを見直そうとしたときに、「これ、なんのために書いたんだっけ？」や「どうしてこの処理になったんだっけ？」と思う場面があったかと思います。

長いサンプルアプリケーションの時や、処理が少し複雑な場合はそう感じるときもあったはずです。今回は「あのときどうしたんだっけ？」をなくすために必要なものを学びます。ソースコード内にコメントを残す方法を学び、未来の自分に当時の考えを伝えるようにする方法を覚えましょう。

C#でコメントを残す方法

ソースコード内にコメントを残す方法にサンプルを書いていきます。新しいコンソールアプリケーションで作成しました。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace App21
{
    class Program
    {
        static void Main(string[] args)
        {
            //入力値を受け取ってint型に変換する
            int inputValue = Convert.ToInt32(Console.ReadLine());

            if(inputValue < 0)
            {
                //変換後の数値が負の数の場合
                Console.WriteLine("負の数です。");
            }
            else if(inputValue < 10)
            {
                //変換後の数値が10より小さい場合
                Console.WriteLine("1桁の数値でした。");
            }
            else
            {
                //変換後の数値が10以上の場合
                Console.WriteLine("10以上の値です。");
            }

            Console.ReadLine();
        }
    }
}

コメントを交えてプログラムを書いてみました。C#でコメントを残すには「//」キーワードの後に記述をすることで、記述後の1行すべてがコメントとして扱われます。それ以外では「/* */」で囲まれた範囲をコメントとして扱うこともできます。

//記述した行の残りすべてがコメントになる。

/*
 複数行でも
 コメントを記載することができます。
*/

このようなコメントをうまく使うことでソースコードに、必要なコメントを残すことができます。コメントを使うことで「どうしてそうなったか」や「〇〇の場合にどんな処理をする」という内容を残せるのです。これは便利ですよね。

コメントを書くメリット

C#では単行のコメントだけでなく、複数行にわたるコメントを記述することもできるので、少し長いコメントも残せるような言語仕様となっています。また、プログラムにコメントを残すメリットはこんな感じにまとめられます。なにはともあれ、コメントはしっかり残しておくべきです。

思考を整理しながら作業することができる
未来の自分が現在の自分の思考を理解できる
他人がコードを読んだ時の助けになる

中でも特に重要なのは「他人（未来の自分を含め）が読んだ時に、当時に考えたことの理解を助けてくれる」ことです。いくら熟練のエンジニアとはいえ、自分が書いたコードすら、半年後に何を書いたか忘れてしまうのです。自分が書いたコードですら忘れてしまうので、他人が読んだら余計に理解されるのは難しいでしょう。

コメントを活用することで「当時にどんなことを考えたのか」や「どうしてこの処理をしたのか」という「思考」を書き残すことが出来ます。コーディングをする際は、将来の自分、もしくはほかのエンジニアに向けた「質の良いコメント」をたくさん残すようにしてください。ほかにもXMLでコメントを残す方法もありますので、こちらも併せてチェックしておくとよいでしょう。