未来の自分へのメッセージ

おはようございます。本日の当番、プログラマーのK.Yです。

日々プログラムを記述している私ですが
その際に気をつけていることのひとつに『コメント』があります。

プログラムでのコメントとは例えば

　　SearchTarget();　//　ターゲットを探します
　　AttackTarget();　//　ターゲットに攻撃をします

のように書かれたときの 『 // 』 より後ろに記述されたものになります。

このようにコメントを書くことにより、
ここではどのような処理が行われているのかなどが分かりやすくなります。

ただ上で挙げた例のようなコメントは、
関数名を見たり流れを確認すればなんとなく分かりますので
特にコメントが無くてもそこまで困ることはないと思います。

では、コメントの何を気をつけているのか。
それは『 この処理が何をしているか 』も重要ですが、
それ以上に『 なぜこのような記述になったのか 』ということです。

いくつか例を

　
例１

　　//　敵１の行動
　　{
　　　SearchTarget();　//　ターゲットを探します
　　　AttackTarget();　//　ターゲットに攻撃をします
　　}

　　//　敵２の行動
　　{
　　　AttackTarget();　//　ターゲットに攻撃をします
　　}

　　なぜ、敵２は SearchTarget() が無いのでしょうか？
　　このように書けば迷わずにすみそうです。

　　//　敵２の行動
　　{
　　　//　敵２は必ずプレイヤーを狙うので他のターゲットは探さない
　　　AttackTarget();　//　ターゲットに攻撃をします
　　}

　　このコメントが無い場合、後々見直したときなどに
　　『 あ、敵２がターゲットを探してないや 』という感じで
　　敵２に SearchTarget() を追加してしまうかも知れません。
　　そうなると、敵２がプレイヤー以外のターゲットに向かってしまい
　　思ったとおりの動作をしなくなってしまいます。

　
例２

　　//　キャラクターのパラメータ設定
　　//　とりあえず
　　chara_HP　　 = 100;
　　chara_Speed　= 10;
　　chara_Power　= 10;

　　なにが "とりあえず" なのでしょうか？
　　昔、このコメントを書いた自分を問い詰めたくなります。

　　そんな時はこんなコメントを付け加えておけば焦ることは無いでしょう。

　　//　キャラクターのパラメータ設定
　　//　パラメータが存在していない時はこの数値を使う
　　chara_HP　　 = 100;
　　chara_Speed　= 10;
　　chara_Power　= 10;

　
などなど、後から読み返すと
『あの時の私は何を考えてこれを書いたのだろうか？』
と思うコメントに出くわすことがあります。

そしてプログラムを読み返して『あー、こうしたかったのね！』
と思うと同時に『ちゃんとコメント書いとけや！わし！』
となるわけです。

　
例３（例１・２と少し意味合いは違いますが、他にもこんなのがあります）

　　//　敵３の行動
　　{
　　　AttackTargetSword();　//　剣で攻撃します
　　　AttackTargetGun();　　//　剣で攻撃します
　　　↑（本当は銃での攻撃）
　　}
　　（コピペしてコメントだけほったらかしになっとるがな・・・）

　　これだけならまだしも、
　　やっぱり敵３は剣での攻撃は無くそうとなった時、
　　AttackTargetSword() の行だけを消したら

　　//　敵３の行動
　　{
　　　AttackTargetGun();　　//　剣で攻撃します
　　}

　　この１行だけになってしまいます。
　　プログラムとコメントが違っているという状況になり
　　後で見直したときに『ん？』となりそうです。

　
未来の自分がそのプログラムを見直したとき焦ることがないように
そして、他の人が読んだときにも誤解を与えないように
プログラムだけでなくコメントも的確に書いていきたいものです。