0

Visual Studio C# プロジェクトから Java Eclipse プロジェクトに doxygen ドキュメントを移植しています。あるスタイルのコメントを別のスタイルのコメントにマッピングするためのチュートリアルまたはガイドを提案してもらえますか?

たとえば、この doxygen コメントを javadoc コメントに変換するにはどうすればよいですか?

/// Solution から派生したカスタム ソリューション データ型

ありがとう

4

1 に答える 1

2

doxygen (C) から javadoc へのマッピングを試みた人の観点から言えば、特に元の解説に多くの物語がある場合、この方向性は非常に難しいと思うでしょう。javadoc には doxygen のほとんどの機能が恐ろしく欠けているので、@param や @return などの絶対最小限のコメントしか転送できません。良いチュートリアルも悪いチュートリアルも見つけたことがありません。これは人々が選択して行うものではないと思います。

doxygen を引き続き使用できるかどうかを検討してください。Doxygen はすべての javadoc コマンド (少なくとも私が遭遇したすべてのコマンド) を解釈し、既存の javadoc 処理を混乱させることなく、doxygen の '\' スタイルのコマンドを Java の解説に無害に追加できます。

編集:その点を少し明確にするために。\command エントリを使用しても Javadoc に警告やエラーは発生しませんが、\command テキストは javadoc 出力にテキストとして表示されます。

もちろん、欠点は、IDE (Eclipse など) でポップアップが必要な場合はjavadocが必要であるため、それが必要な場合は、代わりに doxygen を使用してもあまり役に立たないことです。ただし、高品質の HTML ドキュメントや図と説明付きのマニュアルを作成する必要がある場合は、オプションになる可能性があります。

于 2013-07-24T13:09:08.363 に答える