ソースコード中にメモをとるツール

ソースコード中にメモをとるツール

　日常の生活であれば、忘れそうなことは紙にメモをとります。ソースコードを読む作業においても同じ手が使えないでしょうか。記憶力が原因で規模の大きいソースコードを読むことに限界を感じていた筆者は、常用しているエディター（Emacs）上で動作するメモをとるツール（stitch.el）を開発することにしました。

　まずは動作画面を見てください（図2-1）。これはstitch.elを用いて、「Linuxカーネルのnumaノードとzoneと呼ばれるメモリ管理機構との関係」を読解しようとしていたときのEmacsのスクリーンショットです。

　stitch.elを使うとソースコード中に細ぎれの文章（メモ）を挿入できます。コード読解中にメモを挿入したくなったら、挿入したい場所にカーソルを移動して、特別なキー操作（\C-x 4A）を実行します。するとメモを書き込むための特別なウインドーが開きます。メモを書き終えたらキー操作（\C-c \C-c）によってメモの内容がカーソル個所に挿入されます。メモが挿入されている部分にはソースコードを表示している部分とは異なる特別な背景色（灰色）を使うため、元からあるソースコード部分とは視覚的に区別できます。メモをとった日付とユーザーの名前がメモのヘッダとして付加されます。

　テキスト以外に特別な書式を使うことで図を挿入することができます。graphvizのdot形式を用いれば有向グラフ、無向グラフを挿入できます。図2-1では、筆者が理解できたnumaノードとzoneとの関係を有向グラフで記録しています。またEmacsが内蔵するファイラー（dired）の画面にも、メモを挿入できるようにしました。個々のソースコードではなく、ビルドの仕組みやソースツリーの構造を把握するために使えます。図2-2はLinuxカーネルのソースツリーのトップレベルのディレクトリが、それぞれ何を格納しているかについてメモをとったところです。

　図2-1中のメモには、コードを読んでいるときに得られた知見をまとめています。しかし普段筆者がとるのは「ここまで読んだ」とか「ここがあやしいので後で読み直すこと」といった読解の進行状態に関するメモが多いです。

ほかの方法との比較

　stitch.elのような特別なツールがなくともメモをとれないわけではありません。すぐに思いつくのはコンピューター上ではなく紙にメモをとる方法と、コメントとしてソースコードを直接編集してメモを書き入れてしまう方法です。しかし以下のように考えてstitch.elを開発することにしました。

　メモはソースコードとは独立したファイルに保存されていてます。メモを挿入した後、Emacsを終了させても、次にソースコードを開く機会があればメモは自動的に再挿入されます。紙のメモであれば、必要なときに見つからない恐れがあります。そもそもメモをとったことすら覚えていないこともありえます。stitch.elのメモにはそのような心配はありません。その個所でメモをとったかどうかは、その個所にメモが表示されているかどうかで判断できます。またコンピューター上のファイルであれば迅速に検索できます。

　プログラミング言語のコメント文法を活用してソースコードにメモを直接挿入する方法で、stitch.elと同じ目的を達成できそうです。しかし筆者はソースコードそのものを変更したくありませんでした。前回「RHELを題材にソースが見える環境を作る」（http://thinkit.jp/article/863/1/）の記事
で紹介した通り、勤務先に構築したsources環境では、ソースコードはマスターデータとしてNFS経由で同僚の間に共有されています。そのようなデータは簡単に変更できると混乱の元になるので、OSレベルでファイルの変更を禁止して運用しています。sources環境にあるソースコードをホームディレクトリなど別の場所にコピーして、コピー先のファイルにコメントとしてメモを挿入する方法も考えられます。しかし、コピーを持ってしまうと「同じソースコードはいつも同じパスで参照できる」というsources環境のうまみが薄れてしまいます。