148

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

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

4

11 に答える 11

122

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

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

于 2009-07-03T15:03:50.950 に答える
39

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

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

于 2009-07-03T15:04:47.563 に答える
9

JDKのソースコードはどうですか?

于 2009-07-03T14:59:32.677 に答える
6

私はいくつかのドキュメンテーション パターンを使用しています。

  • スレッドセーフについて常に文書化する
  • 常に不変性を文書化する
  • 例を含む javadoc ( Formatterなど)
  • 注釈付き要素を置き換える WHY と HOW を含む @Deprecation
于 2009-07-03T15:04:17.783 に答える
5

Spring フレームワークのソースを見てください。優れた javadocs があります。

于 2009-07-03T21:41:14.237 に答える
3

たとえば 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 から開始します。

于 2009-07-03T15:06:02.490 に答える
2

Eclipseを使用している場合は、 Installed JREsでJDK ( JREではない)をセットアップしてから、 Open Type ( + + ) を使用して、次のようなものを指定できます。CtrlShiftTjava.util.Collections

于 2015-03-06T12:12:52.010 に答える
2

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

于 2016-08-18T09:23:49.033 に答える
2

Luceneのソースをダウンロードして、その方法を確認してください。優れた JavaDocs があります。

于 2009-07-03T14:59:50.820 に答える
1

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

于 2009-07-03T17:19:06.150 に答える
1

探しているのが構文だけである場合、これが役立つ場合があります。

Javadoc ツールの Doc コメントを記述する方法

于 2009-07-03T15:07:08.290 に答える