IT業界は日々進歩していますが、
それは技術に限った事ではありません。

実は「考え方」の様なものも
昔から変わってきているものが
多くあります。

その一つが
ソースコードのコメントに対する
考え方・・・

プログラムのソースコードには
通常、コメントと呼ばれるものを
書く事ができます。

 

この1番上の行
「1 から 100 まで足す」
と書かれている部分がコメントです。

コメントはコンピューターが
プログラムを実行する上では
解釈される事はなく、無視されます。

つまり、コメントというのは
人がコードを読むのを
補助する役割があります。

実は、このコメント・・・
私が IT 業界に入った当初は

コメントはしっかり書きなさい。

と言われてきました。

ずっと昔ながらの方法で
やってきているチームや組織では
今でも実際に
この手の事が言われています。

コメントをしっかり書く理由としては
いくつか挙げられます。

  • 他の人が見て、どの様なコードか分かりやすくする為。
  • 自分が見て、どの様なコードか分かりやすくする為。(過去の自分は他人と一緒)

要するに、ソースコードを
分かりやすくする為に
コメントを入れる訳です。

しかし、現在は逆に
「コメントはできるだけ書くな」
という意見も出てきています。

理由は以下の通りです。

  • コメントを維持するのにコストがかかる。
  • 維持されていないコメントは嘘情報になる。

ソフトウェアというのは修正や拡張がつきものですが、
コメントを書いてしまうと、
ソースコードを修正する度にコメントの修正も
必要となり、コストがかかってしまう。
もしも、コメントの修正を怠ってしまうと
それは嘘の情報になり、
ない方が良いものになってしまう・・・
という訳です。

では、コメントを書かない人達は
ソースコードの分かりやすさは
どうでも良いと考えているかというと
そうではありません。

どちらも、ソースコードを
分かりやすく書くという面では
一致しているのですが、
コメント推奨派は
コメントを書くことでソースコードを分かりやすく・・・
コメント非推奨派は
コメントなしでも分かりやすく
ソースコードを書く事を意識しています。

極端な例をあげると以下の通りです。

コメント推進派は
コメントで説明を書いていき、
コメント非推奨派は
できるだけコメントを書かなくても良い様に
名前や構造を分かりやすくする様に
心がけます。

これは、ある意味 iPhone に似ています。

かつては、新しいハードウェアが
発売されれば、
分厚い取扱説明書が一緒についてくるのが
普通でした。

しかし、iPhone には説明書が
ついていません。

これは、説明書に操作方法を記述するのではなく、
説明書がなくても操作できる様に
ユーザーインターフェイスを
分かりやすくするという逆の
発想を取った為です。

ソースコードも
昔は「コメントをきちんと書きましょう」と
いう様に言われてきました。

しかし、現在は
コメントを書かなくて済む様に
ソースコードの方を分かりやすくしようという
発想も出てきています。

これは、先人達がソースコードのコメントで
苦労した結果、
出てきた知恵ですが
昔ながらの開発を続けているところは
そういう考え方が出ている事自体
知らないのが現状です。