ソースコードにおけるコメントについて。

プログラマーを悩ませる問題の一つとして、コメントがあると思います。

基本的にコメントには正しいことを書かなければいけないのですが

修正を加えられることによって、コメントと内容が異なってしまうことが多々ありまして

コメントと実装が異なると、のちにコードをメンテナンスするプログラマーは混乱します。

で、コメントはどれくらいの頻度であるべきか?ですが、

これはプロジェクトにもよりまして、

1行1コメントとルールが定められているプロジェクトもあれば、

コメントを残してはいけないというプロジェクトもあります。

まぁ、これは両極端の例ですが。

傾向としては、C言語はコメントを残せというケースが多いように思います。

C言語は関数名、変数名を長くするのは好ましくないという印象があります(偏見

だから意味を極端に省略していった結果、コメントがないとコードが理解できない、という結果になります。

逆にJavaなどのオブジェクト指向言語は比較的コメントが少ないように思います。

こちらは関数名、引数名だけで意味が伝わるように命名しなければならない、という傾向が強いので、

コメントがなくても、関数名、変数名である程度意味が伝わったりします。

そこを突き詰めていった結果、コメントが必要なコードが好ましくない、という考えに行き着いたんでしょうね。

コメントといえば。

昔のプロジェクトはSVNやgitなどのソースコードのバージョン管理の仕組みがなかったので、

ソースコードに修正履歴を残しなさい、というルールが存在していました。

昔のエディターはコメントを色付きで表示する機能も無かったので、

一生懸命解析していたところがコメント化した変更前のコードだった、

ということがよくありました。

現在はこういった修正前のコードは残すのは逆に好ましくないとされています。

そう言うのはgitなどで管理してくれるので。

便利な世の中になったもんだ。

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください