Eyes, JAPAN Blog > バージョン管理とドキュメント

バージョン管理とドキュメント

beko

この記事は1年以上前に書かれたもので、内容が古い可能性がありますのでご注意ください。

プログラムがいつ書かれたか、どのように動作するかを常に把握することは重要ですが、数年も前に書かれたコードは大抵頭の中からなくなっています。
そのため、バージョン管理やドキュメント作成が重要となってくるのですが、人の手で全てを作成するのは大変な手間がかかりますし、おろそかにしてしまうことも多くなります。
C++のドキュメント作成ツールであるdoxygenのwindowsGUI版が出ていましたのでご紹介します。

まずは、下記サイトよりdoxygen-1.6.1-setup.exeをダウンロードしてください。
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
インストーラを起動し、指示に従ってインストールを行います。
次にコマンドプロンプトを開き以下のように入力を行って設定ファイルを作成します。
>doxygen -g
GUI設定ツールであるdoxywizardがあるのですが、最初からこちらで生成した場合うまくいきませんので、最初は上記コマンドで生成してください。
生成された設定ファイルを開き、内容を変更して日本語を使えるようにします。
DOXYFILE_ENCODING = Shift-JIS
INPUT_ENCODING = Shift-JIS
OUTPUT_LANGUAGE = Japanese
次にdoxywizardを開き、FILE > Open より編集した設定ファイルを読み込みます。
最後にプロジェクト名、バージョン番号、出力ディレクトリを入力し、RUNタブより実行をおします。
これによって、プロジェクト内にhtmlドキュメントフォルダが作成されます。
(もし、javadoc形式コメントが解析不能であったり、設定にエラーがあったりしますと、エラー終了してしまいます。)
このツールによって作成されたドキュメントは非常に見やすく、ソース内コメントとしてもわかりやすいものとなります。
管理をしてこなかった方はこれを期に、是非Doxygenを使ってみてはいかがでしょうか。
なお、以下のサイト様を参考にしました。
http://trivia.cocolog-nifty.com/blog/2007/12/doxygen_4f97.html
http://skazami.web.infoseek.co.jp/tools/Graphviz_Doxygen.htm

松浦

  • このエントリーをはてなブックマークに追加

Comments are closed.