Doxygen を使用して Java パッケージをドキュメント化する方法がよくわかりません。C++ では、宣言されているとおりに名前空間を単純に記述することができますが、Java パッケージは実際には明示的に宣言されることはありません。パッケージ mypackage.subpackage; の前に説明を追加してみました。宣言するが無駄。私がそのような作品を見つけたのは、新しいファイルを作成して単純に行う場合です
/**
@namespace mypackage.subpackage
@brief my description
*/
wikiに出てくるのですが、一部のパッケージは正しく記載されていて、残りは重複していて不思議です(記載すべきパッケージが記載されておらず、代わりに空の同じ名前の別のパッケージが作成されています)。
Doxygen で Java パッケージを記述する正しい方法を知っている人はいますか?
簡単に参照できるように、 stackoverflow.com /questions/7368584/doxygen -and-package-html からコピーペーストします。
Java パッケージのドキュメントを提供する新しい代替方法は、package.html の代わりに package-info.java という名前のファイルを使用することです。(ファイル名は、有効なクラス名にならないように意図的に選択されています。)
構文が異なります。
/**
* any javadoc comments (including tags)
*/
package name;
Java 1.4 以下を使用している場合package.htmlは、完全な形式の html ファイルが必要です。
1.4 以降では、package-info.java ファイルを次の形式で使用できます。
/**
* com.foo is a group of bar utils for operating on foo things.
*/
package com.foo;