ホーム < ゲームつくろー！

Doxygen編

　ゲームを製作する時に、見落としがちになってしまうのが「ドキュメント化」です。自分が作成したライブラリにある程度のドキュメントをつけておかないと、2ヵ月後にはすっかり他人コードに化けてしまって中身を忘れます。そういう時にドキュメントがあると思い返すきっかけとなり、またライブラリの寿命も延びます。

　本編で取り上げるDoxygenはドキュメント自動生成ツールの一つです。コードに埋め込まれた特殊なドキュメントを読み込んで、HTML形式などのドキュメントを生成してくれます。

　コードのドキュメント化は悩ましい問題です。例えばテキストファイルやWordなどでドキュメントを作ったとしましょう。この場合、書式を揃えるのがまずは大変です。クラス名はスペース2つ、メソッド名は4つ入れて引数は…。これを作成したすべてのクラスで行う事を想像すると怖いです。またせっかく作成したドキュメントも直ぐに見たい所に行けなければ使い勝手が良いとはいえません。テキスト形式はそういう意味でも使えません。Wordはリンクを張れますが、手作業で全部…はありえないでしょう。

　HTML形式は整形・リンク共に可能です。しかし、これを手作業で作ると「バージョン管理」の問題にぶち当たります。作りかけのクラスのドキュメントを手作業で作ったとしましょう。しかし、この段階でクラスの仕様はちょこちょこと変わります。クラスをちょっと変える度に、手作業で作成したドキュメントの方も変更が必要になります。ここで「作業の2重化」が発生してしまうわけです。これは、やってみるとわかるのですが、恐ろしいほどの手間と時間が負荷になり、あっという間に管理しきれず破綻をきたします。

　という事で、コード作業とドキュメンテーション作業の2重化をなるべく防ぎつつ、HTML形式でリンクが張られたドキュメントを自動で作ってくれるというのは非常にありがたいわけです。この編ではそんなDoxyGenの基本的な使い方に焦点を当てて、気楽にさっと使用する手立てを考えてみたいと思います。

	その１	Doxygenの導入	2009. 3. 29
	その２	日本語マニュアルの作成	2009. 3. 30
	その３	ヘッダーファイルにDoxygenコメントを追加する	2009. 3. 30