プログラムのコメントについて

今や小学校から必修化されるともいわれているプログラミング。

簡単なプログラムであれば、初心者であっても組むことはできるものの、自分の作ってみたいプログラムを組もうとする時点で挫折する方も多いのではないかと思います。

ここでは、プログラムを組む上で大切で、しかも簡単に実行できるコツとして、コメントの付け方を紹介したいと思います。

コメントの付け方

どんな言語でもコメントを付けることができます。コメントはどんな場合に付けるべきでしょうか。次のようなコメントをよく見かけます。

// 曜日が土曜日か日曜日ならスキップ
if ( week == “Sat” || week == “Sun” ) continue;

このコメント、必要でしょうか?プログラム文を見れば、曜日が土曜日か日曜日の場合はスキップするということは一目瞭然です。このプログラムを将来、次のように変更したとしましょう。

// 曜日が土曜日か日曜日ならスキップ
if ( week == “Sun” ) continue;

プログラムでは曜日が日曜日のときだけスキップするようになりましたが、コメントの方はそのままで変更を忘れています。

次にこのプログラムを見た時(それはずっと先のことになるかもしれません)、果たしてどちらが正しいのか悩むことになります。

処理そのものを説明するようなコメントは不要です。コメントを付ける前に、プログラムだけで他人が(それは将来の自分である場合もあります)理解できるようにならないかを先に検討しましょう。

たいてい、コメントは関数やメソッドの前や、変数・定数などの宣言で付けるのが普通です。それ以外の場所でコメントを付ける時は、本当にそれが必要かを考えましょう。

修正箇所のコメントアウト

昔のプログラムではよく、修正時に前のコードを残しておくのを見掛ける時があります。

// 2019.07.11 曜日の判定を変更
// if ( week == “Sat” || week == “Sun” ) continue;

if ( week == “Sun” ) continue;

今はバージョン管理ツールというものがあって、差分も簡単にチェックすることができます。コメントでコードを残すのは、プログラムを見づらくさせる要因になるので避けるようにしましょう。

もし、変更中だけコメントアウトしておくのであれば、最後に必ず消しておくようにしましょう。

シェアする

  • このエントリーをはてなブックマークに追加

フォローする