Doxygen for XOOPS Cube (2)
XOOPS は、 PHPDoc をドキュメントシステムとして使います。Doxygen と、 PHPDoc
の両方は、 javadoc
のドキュメントタグを扱うことができます。しかし、各ドキュメントシステムは、いくらかのオリジナルの規則を持っています。そして、
Doxygen が C/C++ のために開発されてきたので、 Doxygen は、 PHP
プログラムのために上手にドキュメントを生成できないかもしれません。
しかしながら、 Doxygen は、 PHPDoc よりあなたのために使い易いでしょう。私は、
Doxygen によって生成されたドキュメントが好きです。XOOPS Cube において、我々は、
Doxygen のオリジナルのタグを利用するべきでありません。従って、生成されたドキュメントは、
Doxygen の最大効果を含みません。しかし、それは、十分です。
試してみましょう。まずはじめに、 CVS
から最新版をチェックアウトしてください。それをするために、あなたは、 XOOPS Cube Gems
でこの記事を参照できます。次に、 Doxygen
をダウンロードして、そして、それをインストールしてください。
次のエントリで、あなたは、これらのソフトウェアによってドキュメントを生成するでしょう。また明日お会い致しましょう。