私は、doxygen を使用してドキュメント出力を生成する C++ プロジェクトに取り組んでいます。私たちが使用するドキュメンテーションの方法は次のようになります。
//! This is an awesome method. You should totally use this method for all sorts
//! of cool stuff that you might want to do.
//! @returns something useful
string my_awesome_method() {...}
ご覧のとおり//!
、doxygen コメント ブロックを示すためにコメント プレフィックスを使用しています。これが私たちのニーズに非常に適していることがわかりました。
現在、Java コンポーネントを追加していますが、Javadoc で使用されている扱いにくいと思われるスタイルに移行するのではなく、C++ で使用していたコメント スタイルとの一貫性を維持したいと考えています/** */
。doxygen のように他の接頭辞を javadocs に認識させる方法はありますか? または、javadocs を使用する必要があり/** */
ますか? doxygen をそのまま使用することもできますが、このエコシステムとのインターフェースを維持したいと考えているように、Javadoc を中心に構築されたあらゆる種類の機能があります。
これは可能ですか?残念ながら、答えはおそらくノーです。:(