Javadoc の良い例 [終了]
https://stackoverflow.com/questions/1079713
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian質問
の良い例はありますか ソースファイル 含む Javadoc?
Javadoc の良い例はインターネット上でたくさん見つかります。それらを作成するために使用される特定の構文を調べたいだけです。また、どこかのライブラリのソースを詳しく調べられると思いますが、それは大変な作業のようです。
解決
どのようにJDKのソースコードについては、しかしdocjarのようなサードパーティを介してアクセスしますか？たとえば、コレクションソースでます。
こうすることで、大したダウンロードはありません。
他のヒント
ページのJavadocツールのドキュメントCOMENTSを書く方法は、良い例のかなりの数が含まれます。一つのセクションは、ドキュメントコメントするの例と呼ばれ、かなりの数の用法が含まれています。
また、のJavadocよくある質問には、いくつかのより多く含まれています答えを説明するための例。
どの程度 JDK のソースコード？
私はドキュメント パターンの小さなセットを使用します。
- スレッドセーフについて常に文書化する
- 不変性を常に文書化する
- 例を含む javadoc (例: フォーマッタ)
- @非推奨とその理由と注釈付き要素の置き換え方法
Springフレームワークのソースを見てください、それは優れたjavadocを持っている。
例えばANT - ソースコードを閲覧可能なオンライン：<のhref = "http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java ？ビュー=共同」のrel = "nofollowをnoreferrer"> http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co
他のファイルを選択するには、スタートから：<のhref = "http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528" REL = "nofollowをさnoreferrer"> http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528 の
のLuceneするのソースをダウンロードして、彼らはそれを行う方法を参照してください。彼らは良いのJavaDocを持っています。
を使用している場合の、その後、あなたが設定できるのEclipseのあなたの JDK の（いないのJRE の）中のインストール済みのJRE を、その後、使用の のオープンタイプはの（ Ctrlキー + + T SHIFT）、与えますjava.util.Collectionsのようなもの。
グーグルグァバの<のhref = "http://google.github.io/guava/releases/19.0/api/docs/com/google/common/eventbus/package-summary.html" のrelのドキュメント=」 nofollowを "> EventBus のパッケージおよびクラスは、Javadocの良い例です。特に、クイックスタートとパッケージのドキュメントがよく書かれています。
、src.zipは、すべてのパブリックJavaクラスのソースが含まれています。これらのほとんどはかなり良いJavadocを持っています。
あなたが探してすべての構文をされた場合、これが役立つことがあります：
Javadocツールののドキュメントコメントを書く方法
