web-dev-qa-db-ja.com

Javadocの良い例

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

私はインターネットでJavadocの良い例をたくさん見つけることができます。それらを作成するために使用される特定の構文を見つけたいと思います。

javajavadoc
134
Jason S

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

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

112
GaryF

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

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

37
Jared Oberhaus

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

9
butterchicken

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

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

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

4
Gaël Marziou

たとえば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

3
Nick Fortescue

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

2
Marvin Frommhold

Lucene のソースをダウンロードして、その方法を確認してください。彼らは良いJavaDocsを持っています。

2
RichieHindle

Eclipseを使用している場合、JDK（notJRE）in Installed JREs、次にOpen Type（Ctrl + Shift + T）、Java.util.Collectionsのようなものを与えます

2
KrishPrabakar

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

1
Thorbjørn Ravn Andersen

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

Javadocツールのドキュメントコメントの書き方

1
Jesse