連載
» 2007年11月28日 00時00分 公開

ecloxとdoxygenで仕様書メンテナンスの効率をUP!生産性向上への道 Eclipseで行うC/C++開発(4)(1/4 ページ)

仕様書メンテナンスの課題「ドキュメントとソースコードの整合性の乖離(かいり)」をecloxとdoxygenを使って解消する。

[小泉健(NEC) ,@IT MONOist]

 本連載では、組み込み開発に「Eclipse」を適用するメリットおよび適用方法の概要を紹介してきましたが、今回でいよいよ最終回となります。

 第1回「組み込み開発におけるEclipseの有効性」では、EclipseのメリットやC/C++開発に利用できるプラグインの紹介をしました。第2回「『CDT』で効率的なC/C++開発を実現する」と第3回「CDT/RSEによるクロスコンパイルとリモートデバッグ」では、CDTとRSEを利用したC/C++アプリケーションの開発方法を紹介してきました。

 最終回となる今回は「eclox」と「doxygen」を使ったドキュメントの自動生成について解説します。

 今回の内容を読み進める前に、これまでの連載記事をもう一度読んでおくと、より理解が深まると思います。doxygenとecloxの概要、バージョン情報やインストール方法については第1回「組み込み開発におけるEclipseの有効性」を参照してください。

doxygenとは?

 まずは「doxygen」について簡単に紹介します。

 doxygenとは、Dimitri van Heesch氏らによって開発された“C/C++に対応したドキュメント生成ツール”です。Javaをご存じの方は、Javadocをイメージいただけると分かりやすいと思いますが、ソースコードとdoxygen構成ファイルを入力として、ドキュメントを自動生成するものです。

 入力となるソースコードもC/C++言語以外にJavaやPHPなど多彩な言語に対応しています。また、出力されるドキュメントもHTML、LaTeX、RTF、XML、manなどさまざまな形式をサポートしています(図1)。

関連リンク:
doxygen公式サイト

doxygenの概念図 図1 doxygenの概念図

 ソースコードにコメント形式で、パラメータ、返却値の意味や事前条件、事後条件などの仕様を埋め込むことにより、関数のインターフェイス仕様書レベルのドキュメントを生成できます。これにより、開発現場にありがちな“ドキュメントとソースコードの整合性の乖離(かいり)問題”が軽減します。特に自分で作成した関数をほかの人に公開したい場合などに利用すると非常に便利です。

ecloxとは?

 続いて、「eclox」について紹介します。

 ecloxとは、Guillaume Brocker氏が作成した“Eclipse上からdoxygenを制御するプラグイン”です。ecloxを利用することでEclipseのグラフィカルなインターフェイスを通じてdoxygenを利用できます(図2)。

関連リンク:
eclox公式サイト

ecloxの概念図 図2 ecloxの概念図

 doxygenとecloxを使ったドキュメント生成の流れは以下のようになります(図3)。

doxygenとecloxを使ったドキュメント生成の流れ 図3 doxygenとecloxを使ったドキュメント生成の流れ

 doxygenとecloxの紹介は以上です。

 次に、第2回「『CDT』で効率的なC/C++開発を実現する」で作成したC/C++アプリケーションを用いて、実際にdoxygenとecloxを使ったドキュメント生成の手順について解説していきます。

       1|2|3|4 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.