Javadocの良い例[終了]

Javadocを含むソースファイルの良い例はありますか？

私はインターネット上でJavadocの良い例をたくさん見つけることができます。それらを作成するために使用される特定の構文を見つけたいと思います。どこかでライブラリのソースを調べられると思いますが、それは大変な作業のようです。

JDKのソースコードはどうですか？docjarのようなサードパーティからアクセスしますか？たとえば、コレクションのソース。

そうすれば、大きなダウンロードはありません。

Javadocツールのドキュメントコメントを書く方法のページには、多数の優れた例が含まれています。1つのセクションは「Docコメントの例」と呼ばれ、かなりの使用法が含まれています。

また、Javadoc FAQには、答えを説明するためのいくつかの例が含まれています。

どの程度JDKのソースコード？

ドキュメントパターンの小さなセットを使用します。

• 常にスレッドセーフについて文書化する
• 常に不変性を文書化する
• 例付きのjavadoc（Formatterなど）
• 注釈付き要素を置き換えるためのWHYおよびHOWによる@Deprecation

Springフレームワークのソースを見てください、それは優れたjavadocsを持っています

ANTの例-オンラインで閲覧可能なソースコード：http : //svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java? view=co

他のファイルを選択するには、次から開始します：http : //svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

Luceneのソースをダウンロードして、それがどのように行われるかを確認してください。彼らは良いJavaDocsを持っています。

Eclipseを使用している場合は、インストールされているJREでJDK（JREではない）をセットアップし、次にOpen Type（+ + ）を使用して、次のようにします。CtrlShiftTjava.util.Collections

Google GuavaのEventBusパッケージとクラスのドキュメントは、Javadocの良い例です。特に、クイックスタートのパッケージドキュメントはよく書かれています。

JDKをインストールし、ソースもインストールすることを選択した場合、src.zipにはすべてのパブリックJavaクラスのソースが含まれます。これらのほとんどはかなり良いjavadocを持っています。

あなたが探しているものがすべて構文である場合、これは役立つかもしれません：

Javadocツールのドキュメントコメントを書く方法