Doxygen for XOOPS Cube (1)
XOOPS Cube が多くのファイルと多くのクラスを持つため、 XOOPS Cube
のソースコードを読むことは難しい。Cube のソースコードを読むために、私は
Doxygen
を推奨します。 Doxygen は有名なドキュメントシステムであり、ソースコードを解析して HTML
ドキュメントを生成します。そうです、それは
javadoc
の一種です。Doxygen
がクラス名とファイル名でドキュメントをサーフィンするためにハイパーリンクを作成するので、生成されたドキュメントは本当に有益です。あなたはネットサーフィンをするように「ドキュメントサーフィン」をすることができます。
ソースコードをあなたのドキュメントに出力するために、ソースコードオプションを有効にすると良いでしょう。生成されたソースコードページは、クラス名と定数のところで、同様にリンクを含んでいます。これらのページはIDEを使うより良い。あなたは必要なクラスと定数を容易に調査し得ます。
恐らくあなたはソースコードを読むのに IDE を使うことをやめるでしょう（その IDE が
VisualStudio だとしても）。
ドキュメントシステムのためにすべてのクラスがコメントを持っているわけではないので、生成されたドキュメントは十分に我々の書いた概要を含んでいません。しかし、私は
Doxygen が重要な情報を自動的に生成するので、そのドキュメントはあなたにとって有益だと思います。