エンジニア

プログラミングでコメントを入れるのは面倒だけど意外と大切

コンピューターの機能とは

コンピューターの機能を大別すると、入力、処理、出力の3つです。
今回の話題は「処理」、つまりプログラミングです。

IT業界に入って、先輩に言われたことがある。

「プログラムのコーディングは入力があり、処理があり結果がある。処理にはいろいろの手法があるが、結果さえ合っていれば問題なし」
ずいぶんいい加減だなとは思いましたが、大きく間違ってはいませんね。

例えば、入力に12が入り、結果4になる計算式があるとする。

  • 12÷3=4
  • 12-8=4
  • 48÷12=4

これら答えは全て同じになり、いろいろな計算式があり、人それぞれ考え方は違います。
プログラムも考え方は、同じではないかと思います。
答えは、「結果を4にする」という1つしかありません。

未来の誰かのために

私はコーディングするうえで、「コメント」を残すということに気を付けています。

コメント、正式にはコメントコーディングと言いますが、コンピューター言語(C言語/C++、Python、Java、perl、HTML等)によって書かれたソースコードのうち、人間のための覚え書として書かれた注釈のことです。
コメントアウトという呼び方もありますが、この場合はプログラムの変更によって必要なくなったソースコードを削除せずに残しておくためにコメント化する場合に使います。

どんな処理をしているのか。

通常なら△△という処理をするのに、〇〇という処理をしているのはどうしてなのか。
どんな条件で何を判断をしているのか。
ソースコードを変更した場合、元のコードはどうだったのか。
それらを後世に残すためにコメントを記述しています。(笑)

コンピューター言語によってコメントの方法が異なり、「#」「/」「<!」など、いくつかの種類があります。新規コーディングだけではなく、他人が作成したソースの修正もあります。

自分で書いたソースなら、思い出すでしょう。しかし思い出すにも時間がかかります。コーディングには、それぞれクセがあり、読みにくかったり、理解しずらかったりします。その人の性格が反映されるのがコーディングなんですね。

コメントがあれば、処理内容がわかり、理解もしやすくなります。
ですから些細な事でもコメントを残すようしています。
また、むやみやたらコメントを残しても、逆に読みにくソースになってしまいます。

未来の自分のために

私が初心者の時に残したコメントですが、そのコメント自体が分かりにくく、今見ると恥ずかしくなります。

そのプログラムに変更が加わった場合、誰かが「いったい何書いたんだ?」とイライラしているかもしれません。

だって、現在の私が他の人が書いたプログラムを見て同じことを言って舌打ちしているんですから。
未来の自分のためにもコメントの書き方には十分注意しましょう!!

アップリーチ記事編集部

この記事を書いた人

アップリーチ記事編集部

1998年創業のシステム開発会社。汎用系システム開発とWEB制作を多く手掛ける。現在はアプリケーションの開発とサービス運用に注力。アップリーチ記事編集部では、システム・WEB・デザインなど様々な領域で発想を飛ばし、アイディアを紡いできたメンバーがノウハウやハウツーを発信しています。

関連記事

TOP