iPX社員によるブログ

iPX社員が"社の動向"から"自身の知見や趣味"、"セミナーなどのおすすめ情報"に至るまで幅広い話題を投下していくブログ。社の雰囲気を感じ取っていただけたら幸いです。

コメントをコメント

最近、「もう若くないなぁ・・・」としみじみ実感しております。阿部でございます。
とかく実感する、体力の回復能力の低下。今年はとみに「ああ、夏バテってこんな感じなのかなぁ」などと感じる夏です。

さて、今回は表に出ては困るけど、開発者の強い味方(のはず)のプログラム中のコメントについてお話させていただければと思います。

そもそもプログラムにおけるコメントって?

コンピューターのアプリケーションはプログラムを元に作られます。
プログラムは当然様々なコンピューター言語(C++とか、Javaとか)で作成されるのですが、そのままでは内容が解りづらいため、人間が読める言語で
注釈をつけることが往々にあります。
しかし、プログラム中にそのまま書いてしまっては、ただのエラーのもととなってしまうため、「ここは処理しない部分」であることを示した必要があります。
この処理しない部分をコメントと言ったりします。

コメントにも2種類ありまして

コメントの記述方法としては2つあり、「行コメント」と「ブロックコメント」があります。
行コメントは1行だけをコメントとすることができる方法で、ちょっとした注釈を書くのに向いています。
一方、ブロックコメントは特定の記述をなされた間をすべてコメントとする方法です。改行を跨ぐ事ができるので、大きめな内容を書くのに適していると言えるでしょう。
ブロックコメントは行単位ではなく指定区間なので、行の途中に書くこともできるのですが、誤ってブロックコメントを入れ子にすると間違いなくろくなことにならないので、避けたほうが良いでしょう。*1
行コメントにしても、ブロックコメントにしても、適材適所に使い分けることが肝要です。

注釈つける以外にも

先に記述したとおり、コメントの主な使用用途はプログラムに対する注釈がちょっと違った使い方ができます。

コメントとされた部分がプログラムとして認識されないという点を利用して不要になった部分を削除せずその部分の処理を行わないようにする
手法がコメントアウトです。修正するときに元の部分を残しておき、修正前後の動作見比べたりする際に便利だったりします。
ただ、修正後に残したままにしておくと、あとから見たときに「これ消して良かったんだっけ?」とかなったりしますが・・・。*2

何事も使い方が肝要

昔は更新履歴等もコメントでやっているプロジェクトもあって、プログラムが日に日に読みづらくなったりしたこともありました。
また、コメントもちゃんとアップデートしていかないと、実装との乖離が発生してただの邪魔者になったりします。
あと、意外と大事なのが「コメントは見えないもの」と思い込まないことでしょうか。実は、セキュリティリスクになったりもします。*3
使い所を考えたり、ちゃんとメンテナンスしないと用をなさなくなるのはある意味プログラムの一部ということでしょうか。
使うときは自分が判ることが大事ではなく、他の人が見たときにわかりやすくするのがコメントの使い方の肝要なところではないでしょうか。

*1:そもそも見づらいですし・・・

*2:いらないと思って消したら実は必要だったりとか結構あるんですよ・・・。

*3:HTMLのコメントはソース見ると見えちゃいますし、それで一騒動起こった事例もあります。