納品物の中によく「ソースコードのドキュメント」とありますが、いちいち作るのがめんどくさいです。

しかも、そのドキュメント作成の工程が「○人日」とかになってたりします。

ドキュメントは大切ですが、どうしても楽したいですよね。（僕だけ？）

そこで、Doxygenを使ってドキュメントを自動生成します。

Doxygenを使うドキュメント生成は、

• 普段から決まったコメントの付け方をする
• Doxygenの使い方を覚える
• Doxygenでドキュメントを生成している時間待つ

の3つを行うだけで、簡単にできます。

生成されるドキュメントには、HTML形式や、TeX形式などがあります。

準備編

インストール

とりあえず、Linuxのみのインストール方法です。

yum系の場合(CentOS5.2 で確認)

   1  # yum install doxygen

apt系の場合(確認してないですが、おそらく)

   1  # apt-get install doxygen

ソースコードのコメントの書き方

JavaDocスタイルとQtスタイルに対応しています。

詳しくは、Doxygenのマニュアルのコードのドキュメント付けを参照してください。

普段からこの書き方を心がけていれば、初めは面倒でも、だんだんと慣れてくると思います。

Doxygenを使ってみる

準備が終わったところで、さっそくDoxygenを使っていきます。

Doxyfileの生成

まず、プロジェクトのディレクトリに移り、

   1  $ doxygen -g

とし、Doxyfileというものを生成します。

Doxyfileの編集

次に、生成されたDoxyfileを編集します。

デフォルトでは、Doxyfileと同じディレクトリのソースコード類に関してドキュメントが生成されます。

これは、460行目あたりの INPUT のあたりを変更すると、別のディレクトリを参照するように変更できます。

必ずしておくほうが良いのは、230行目あたりの

   1  EXTRACT_ALL            = NO
   2  EXTRACT_PRIVATE        = NO
   3  EXTRACT_STATIC         = NO
   4  EXTRACT_LOCAL_CLASSES  = YES
   5  EXTRACT_LOCAL_METHODS  = NO

を、

   1  EXTRACT_ALL            = YES
   2  EXTRACT_PRIVATE        = YES
   3  EXTRACT_STATIC         = NO
   4  EXTRACT_LOCAL_CLASSES  = YES
   5  EXTRACT_LOCAL_METHODS  = NO

に変更することです。

今回は、超簡単な使い方なので、詳細は省きます。

ドキュメントの生成

   1  $ doxygen

と実行すると、ドキュメントの生成が始まります。

しばらく待つと、完成です。

最後に

以上で超簡単なDoxygenの使い方でした。

これで、「ソースコードのドキュメント1人日で作ってね」と言われても、「え、そんなの10秒でできますが」 と答えれますね！

作業効率がUPです♪

また時間があれば、Doxygenの使い方を詳しく見ていきたいと思います。