プログラミングと開発方法論と情報セキュリティ(主に初心者向け、言語はC#)、その他、ゲーム、思想等。

開発方法論萌え

C# 基本

C#講義第9回 – コメント

投稿日:


C#では、プログラムの中に実行の対象にならない説明文のようなものを書くことができます。

このような説明文をコメントと言います。

この記事ではコメントの書き方について見ていきます。

行末までコメント

『//』記号で始まる行は行末までコメントとなります。

例えば、こんな感じです。

using System;

class Program
{
  static void Main()
  {
    // 画面に文字列を出力します。
    Console.WriteLine("Hello World!");
  }
}

 

ここで、「画面に文字列を出力します。」の部分は自分のプログラムの動作を説明した説明文であって、実行するときは無視されます。

このような説明文のことをコメントと言います。

複数行にわたるコメント

『/*』と『*/』で囲まれた行はコメントになります。『//』との違いは複数行にわたるコメントを書くことが出来る点です。

/* 名前空間 System を省略できます。
例)System.Console.WriteLine("Hello World!");
⇒Console.WriteLine("Hello World!");
*/
using System;

class Program
{
  static void Main()
  {
    Console.WriteLine("Hello World!");
  }
}

 

コメントを書き過ぎてはいけない。

プログラムコードは人間には分かりにくいので、後で読みやすくするためにコメントを書いておきましょうと、昔はよく言われていました。

しかしこの考え方には、現環境では反対意見が出ています。

コメントを書くぐらいなら初めから分かり易いプログラムを書こうというものです。実際、C#の言語機能を駆使すれば、コメントを付けなくても十分に分かり易いプログラムを書くことができます。

また、コメントは実行の対象にならないというのも、ここへ来て困りものになります。コメントの内容がコードの内容と食い違うものになっていて、説明としての機能を果たしていない場合でもエラーになることは有りません。こういうコードは非常に分かりにくくなります。

コメントが多すぎるコードは何か設計に問題があると疑ってかかった方が良いかもしれません。

コメントアウト、コメントイン

使い方

プログラムコードのある部分を一時的に無効にしたい場合、無効にしたいコードの先頭に『//』を付けることがあります。

using System;

class Program
{
  static void Main()
  {
    Console.WriteLine("Hello World!");
    //Console.WriteLine("Hello World!");
  }
}

例えば、上のコードでは Hello World! は1回しか出力されませんが、もう1回分の出力を行うコードはちゃんとプログラムコード中に残っています。

このようにある部分だけを一時的に無効にすることをコメントアウトと言います。

ここで、『//』を消し去ると、Hello World! を2回出力するプログラムコードに戻すことができます。

このように、コメントの機能を使って一時的に無効にした行の『//』を外して再度有効にすることをコメントインと言います。

Visual Studio の機能を使うと、複数行を1括してコメントアウト、またはコメントインすることができます。

メニューバーの「編集」⇒「詳細」⇒「選択範囲のコメント」でコメントアウト、「選択範囲のコメントを解除」でコメントインできます。選択中の行をまとめて一括してコメントアウトまたはコメントインすることができます。

多用すべきでない

コメントアウトは本当に一時的(長くて1時間)に無効化する場合だけ使うようにしましょう。

リリース後のプログラムに実行されない行が大量に取り残されていると、後でプログラムを修正するときに非常に分かりにくくなります。

また、コメントアウトしてから時間が経過すると「この行なんでコメントアウトしたんだっけ?」となることもあります。こうなると本末転倒です。

まとめ

// は行末までコメントです。

/* */ で囲まれた部分はコメントです。

コメントは多用し過ぎないようにしましょう。


管理人が学習に利用した書籍

管理人が学習に利用した書籍を紹介させていただきます。

私がお勧めしたいのは独習C#第3版です。独習C#新版と言うのもありますが、第3版とは異なる著者が書いた本です。

Amazon さん

楽天さん

 

-C#, 基本

Copyright© 開発方法論萌え , 2020 All Rights Reserved Powered by STINGER.