2017-12-04 20 views
0

私は一連の.groovyファイル(Java)を持っています。これらのファイルはすべて同じコメント形式です。 私はこれらのファイルを読んで、REGEXを適用してリスト内のすべてのコメントを取得できるツールを開発しました。 (最後に、これらのコメントを.htmlファイルに貼り付けてコピーするだけで済みます) コメント付きのHTMLページ(ドキュメントの一種)を生成するのが正しい方法であるかどうかを知りたいと思います。そうでない場合は、何をお勧めしますか?groovyファイルのjavaコメントをhtml形式に解析するには?

あなたが生成するために、ライブラリを提案することができる場合、私はDoxygenのとJavadocについて読んけど(コメントはすでに書かれているので、彼らは私の場合は本当に便利です場合)私はそれらを使用についてはよく分からない

HTML Webページやその他のアドバイスを簡単に作成できます。

何か助けていただければ幸いです。

答えて

3

Groovyの場合とほぼ同じJavadocに相当するGroovydocが存在します。

あなたの設定はそうではありません(すでにコメントがありますが、おそらくGroovydoc形式ではなく、ツールの半分があります)、まだ複数の方法があります。あなたがすでにgroovyからドキュメントを抽出しているので、私の場合は必要に応じて最小限のポストフォーマットを行い、ドキュメントをマークダウン(例えば、github markdown)またはasciidoc(例えばasciidoctor)として出力します。次に、任意のツールを使用して、ポストフォーマットのドキュメントをHTMLに変換することができます。

「Javaコメントを解析する方法」という質問に答えるには、そうしないでください。可能であれば、特に新しいプロジェクトでは、標準ツールを使用してください。 Groovyの場合はGroovydocです。ノーマル(Java/Groovy-Doc以外のスタイル)では、ソースコードから抽出する必要はありません。コンテキスト固有のものでなければなりません。対応するコードがなければ、それらは無意味です。

+1

:+1:groovydocメカニズムを使用して[ドキュメントのすべての例をテストする]こともできます(http://blog.bloidonia.com/post/38376843422/automated-javadoc-testing-in-gradle -built-groovy):-) –

+0

ありがとう、私はちょうどGroovydocをダウンロードし、ドキュメントも開いた。 しかし、私は問題に直面しています。 私のグルーヴィーなファイルは非常に簡単です /* --- TITLE --- */ /* - 方法1 - */ いくつかの方法のn までのコード... しかし、生成されたHTMLは空ですコマンドラインは正しいと思われる –

関連する問題