2009-09-21 10 views
11

通常のJavaDocのHTMLish構文ではなく、より多くのWikiスタイルの構文でjavadocを置き換えるツールはありますか?Wikiのような構文を使用するjavadocの置き換えはありますか?

私の問題の1つは、私が主にソース形式でJavaDocを読むことです。外部ライブラリであっても、ソースが添付されているので、IDEからナビゲートして、エントリポイントの上のドキュメントをチェックし、必要に応じて以下のコードをチェックします。

もう1つの問題は、特にIDEがすべての行に星を置くことを主張している場合、リストやコードサンプルなどの記述が面倒であることです。私が見たいのは、少なくとも以下の機能を持つWiki構文の種類を使用するものです。

  • リスト
  • コードブロック
  • 方法に架橋/クラス

ありますいいかもしれないもっと多くのものが、私はこれらが本質であると信じています。

誰もそのようなツールを知っていますか?

+0

コードブロックは '{@code}'であまりにも悪くありません。私は '{@link}'がメンバーや型にリンクするのに合理的にうまくいくと思います。 –

+0

wikiスタイルの表示について考えている間は、wikiスタイルを編集してコメントに戻すこともできます。私はそれが少し尋ねていると思う。 – Carl

答えて

3

WikiDocletというプロジェクトがありますが、これまで私が使ったことはありませんが、あなたが考えるものを見てみたいと思います。

サイトから:

これは、Java JDKが提供する標準のJavadocドックレットを拡張したものです。 Wikiの書式設定をサポートしています。これは、あなたのJavaDocが、JavaDocに埋め込まれたhtmlよりも目が簡単なテキスト規則を使用してフォーマットできるようになったことを意味します。たとえば、テキストを重視する場合は、それを囲むのにとします。斜体のイタリック体アンダースコア。 JavaDocを生成するためにドックレットが実行されると、これらの規則が評価され、HTMLの置換が行われます。この書式設定は、HTMLソースタグがHTMLタグで煩雑にならないため、読み込み用のJavaソースコードをもっと簡単にするはずです。これは、箇条書きリストや表に対して特に当てはまります。それでもHTMLは保存されますので、好きなように組み合わせてマッチさせることができます。

その他のドックレットのフォーマットについては、doclet.comを参照してください。

+0

ニースのリンク - ありがとう。私はそれを撃つだろう。 –

関連する問題