ビットコイン・インスティテュート

ソースコードの​ドキュメント

AndrewBuck 2010年7月15日21:30 UTC

開発者のみんな、こんにちは。ようやくUbuntuマシンにビルド環境を作れたので、ソースコードを少し読んでみた。今のところ気に入っている。プログラムは標準テンプレートライブラリを活用して煩雑なデータ構造のコードを避けているし、クラスの構造もpublic/privateアクセスをうまく使ってモジュール性を高めているようだ。

ただ、本当に足りないと思うのは、.hファイルと.cppファイルの間の適切な構成と、関数のドキュメントだ。Doxygen (http://www.doxygen.org)ドキュメントシステムを使って、関数のドキュメントを喜んで書き始めたいと思う。私が開発リーダーをしているゲームOpenDungeons (http://sourceforge.net/projects/opendungeons/)でもこれを使っていて、とても役に立っている。

Doxygenを知らない人のために説明すると、Doxygenはソースファイルを読み取り、自動的に集める情報(関数のパラメーター、クラスの構成と継承など)と、自分で書き足す情報(関数の説明、変数の用途など)を抽出する。すべてのコードを解析したあと、相互リンクが充実した見やすいHTMLファイル群を入れたディレクトリを生成する。各関数からどのサブ関数が呼ばれるかを示すコールグラフを自動で生成するようにも設定できる(依存関係やバグの追跡に役立つ)。

全体として、Doxygenは優れたシステムなので、喜んでセットアップして関数のドキュメント(少なくとも私が理解できるもの)を書き始め、パッチを出してSVNにアップロードできるようにしたいと考えている。ただ、ほかの開発者が反対するならやりたくないので、始める前にここに投稿した。やってほしければ知らせてほしい。

編集:既存システムのドキュメントがどのようなものか見たい方のために、OGRE 3Dレンダリングシステムのドキュメントへのリンク (http://www.ogre3d.org/docs/api/html/)を載せておく。ドキュメントの雰囲気をつかむには、上部のClassesリンクをクリックして、いくつかのクラスのページを見るのが一番だ。

-Buck