2015年12月14日月曜日

ソースコードを読むときにコメントを除外して読みたい

すでにある大量のプログラムのソースコードを読まなければならないことがある。そのソースコードにはプログラムの実体以外に大量のコメントが書かれていることがある。

コメントは関数ヘッダであったり、処理の流れであったり、注意すべきことであったり、改訂履歴およびその改訂箇所の始まりと終わりを示すものであったりする。それらは「コーディング規約」に基づいて書かれていることが多い。

時間が流れてそのソースコードの担当者が代われば、そのコメント記述の仕方も違いが生じ、二人、三人と代わればコメントの統一感がなくなってくる。コメン トがソースコードの中で大きな顔をしていて、ソースコードを読みにくいものにしている。ソースコード中のコメントの割合が50%を超えるものだって出てく る。

コメントを見ずにソースコードを読みたくなってくる。

わたしはソースコードを読むときにはエディタ Emacs を使っている。Emacsにhide-comnt.el をインストールするとコメント部分を非表示にすることができる。もちろん非表示から表示にもどすこともできる。

だが、コメントが非表示になると、