2022年6月17日プログラミングを始めた当初は楽しさと必死に作り込むあまり、自分の書いたコードが何を意味するのかを残していないことがしばしばあります。いうコードが多いと、何年も経ってからプログラムを維持改良する際に自分の書いたコードの目的がわからなくなることがあります。自分の書いたコードを他の人が手を加えるときにも同じ現象は起きます。良いプログラマーは他の人が見てもわかりやすいコードを書くことができますよね!今回はコードにコメントを残す方法を徹底的に解説していきます!コメントを残すか残さないかで、良いプログラマーなのか否かが決定しますので、プログラミングの習得をしたい方は必ずご覧になってください。目次スポンサーリンクC#には3種類コメントを残す方法があるC#でコメントを残す方法は以下の3種類があります。(“///”で表現)行末までをコメントするC#ではコメントしたい行の始めに「//」を入力することで行末までコメントアウトすることができます。ここにコメントを記載の箇所が全てコメントとなります。}複数行をコメントする先ほどの//でコメントアウトする方法は単一の行には便利ですが、複数行になると結構面倒な作業になります。C#には複数行をまとめてコメントアウトできる方法がありますのでご安心ください。*/で囲まれた箇所が全てコメントアウトされます。}一括で複数行をコメントアウトできるのは便利ですよね?しかし、便利な反面注意しないといけないところもあります。*/でコメントアウトしてみます。すると、最後の「*/」がコメントとして認識されません。複数行をコメントアウトするときはこの辺りを注意してくださいね。関数などの説明に用いるコメント関数などの説明をするときは引数や戻り値などの意味を残しておきたい場合が多々あります。いったときは、XMLとしてコメントを残す方法もあります。Studioでは標準で付属していますが、VSCodeは拡張機能を追加する必要があります。コメント(XMLコメント)を入力したい関数の上で///と入力しましょう。}自動的に///のXMLコメントが入力されます。関数に引数や戻り値がある場合は、paramやreturnsといったタグが追加されて対象の関数に必要な引数や戻り値の説明をすることが可能です。重要な点としては、別のコード上に先ほどのXMLコメントが追記された関数を使用するときです。下記のようにHello関数にマウスのカーソルを当てるとXMLコメントの中身を参照することができるので、どういった関数なのか簡単に確認することができ、効率よくプログラミングをすることができます。まとめ学生や新卒のエンジニア、プログラミングを始めたばかりの方にとってはコメントの重要性はまだわからないかもしれません。私の経験から、コメントをしっかり残しておくことができたプログラムとそうでないプログラムとでは、その後の品質や維持改良の工数に明らかな違いが生じます。ソースコードにコメントを残しておくことで高い品質を維持することができ、良いプログラマーに一歩近づくことができるのです。都内の精密機器を作っている会社に勤務している14年目のエンジニアです。趣味は美味しいものを食べることとゴルフ。プログラムについて今まで学んだことをわかりやすく発信するサイトを目指しています。※サイト次回のコメントで使用するためブラウザーに自分の名前、メールアドレス、サイトを保存する。