UNIX/Linuxプログラミング:仕様書(ドキュメント)を作ろう。仕様書(ドキュメント)を作ろう。プログラミングをしていて、よくソースファイルにコメントで説明を書いておいて、あとで見たりします。人によっては手書きでソースの説明などを残しておく人もいると思います。このようなものはプログラムの仕様書(ドキュメント)といいますが、折角、ソースに書いたコメントをもう一度、手書きでまとめ直すというのは二度手間です。ソースファイルに書いたコメントを元に仕様書を自動生成してくれるアプリケーションを使えば、手軽に仕様書が作れます。仕様書はhtmlやlatexの状態で出力されるので、見易く一般的です。このページでは、C,C++の仕様書を自動生成するdoxygenについて解説します。ソースコード解析機能強化版」を紹介します。doxygen-introductionまずは、doxygenで作成したC++プログラムの仕様書サンプルを見て下さい。wallet.cpp)と利用例(main.cpp)からなる簡単なプログラムです。「構成」のところをみるとクラスの説明が見られます。適当にリンクを辿ると、PublicやPrivateなどの関数、変数が表示されています。この仕様書は、ソースファイルに書かれたコメントを元に、doxygenで生成されたものです。参考までに、元のソースです。Doxyfileの作成doxygenを使うには、まずDoxyfileというファイルを作り、そこに設定を書きます。-gとすると、Doxyfileが作成されます。そこでまずこのDoxyfileの設定をするのですが、以下ぐらいを書き変えれば、まあ、満足できると思います。「」で括ってあるところは各自で、適当に入れて下さい。YESあとは適宜好きな設定にして下さいコメントの挿入つぎにソースファイルにコメントを挿入します。クラスwalletの実現部です。2006/03/17*/のように書いて下さい。/*!と*/で囲われたコメントがdoxygenで認識されます。C++では//!もOKです。\briefにはファイルの要約を、\authorには作者、\dateには作成日時を書きます。クラスや変数などの宣言の前に//!お財布管理用のクラスです。name[20];こんな感じでコメントをいれておけば、その説明となります。最後にdoxygenとすれば、html,latexの仕様書が作成されます。doxygenのコマンドは他にも\todoや\bugなど様々にあります。下の公式ページを参照して見て下さい。doxygenの関連リンクDoxygenの公式サイトです。90の仕様書はdoxygenで作ることができません。いうところがRDOCにたいしてパッチを作っていて、これを用いて仕様書を作成することができます。公式ページはここです。ruby-develをインストールします。ruby-develとします。それで、公式ページの解説を元にパッチを当てます。ようにコメントを書きます。--inline-sourceとすると、ディレクトリ下./doc/に仕様書ができています。インストールのときの?これは一般的ではないと思いますが、インストールのときなぜかテンプレート(html.rb)がきえていたので、直接、パッケージからコピーしました。/usr/lib/ruby/1.8/rdoc/generators/template/html/html.rb。