マニュアルの内容は Javadoc です。Android だけでなく Java を使用した Eclipse でも使用できます。
最初にいくつかのリンクがあります:
http://en.wikipedia.org/wiki/Javadoc
次に、javadoc が役立つ理由を簡単に説明します。まず、(私の意見では) 想像できる最も簡単な方法で実際のマニュアル (Java API は javadoc で作成されます) を作成できます。次のような特別なコメント タグを使用する必要があります。
/**
*
**/
これを宣言 (メソッド、クラス、インターフェース、フィールドなど) の前に置くと、javadoc に含まれます。追加できる標準的なものがあります。たとえば、メソッドの説明、必要なもの、その他多くのことを指定できます。@return
非常@params
に慎重かつ正確に、javadoc を相互にリンクし、非常に複雑で正確なドキュメントを作成できます。
Eclipse では、Eclipse 自体がデフォルトでユーザーが javadoc と対話できるため、javadoc は便利です。たとえば、メソッドの機能を知りたい場合は、マウスをメソッドの名前の上に置くだけで、小さな黄色いダイアログが表示されます。ctrl-space も使用する場合は、いくつかのヒントも含めることができます。たとえば、ctrl-space を押すと、使用可能なすべてのパブリック メソッドが表示され、各メソッドの javadoc が黄色の説明ダイアログに表示されます。新しいオブジェクトをインスタンス化する場合、コンストラクターがいくつ (およびそれらが持つパラメーターの種類) が定義されているかなどを確認できます。これは非常に便利で重要なことだと思います。
2番目のことについては、あなたが何を望んでいるのかを理解していれば、おそらくJUnit(テスト用のユニット)のようなもので十分です。
http://www.junit.org
JUnit はコードをテストするためのユニットであり、Eclipse と完全に統合できます。簡単に言うと、コードの各部分に対して、その動作が正しいかどうかを確認する 1 つ以上のテストを作成する必要があります。いくつかのテストを作成したら、失敗したテストの数、合格したテストの数、およびエラーの種類を示すユーザーフレンドリーなインターフェイスを使用して、テストを自動的に実行できます。
コードの小さな (ばかげた?) ことをテストするのになぜ便利なのですか?
作業コード (自分のコード) があると想像してください。誰かがそれに取り組んでいると想像してください(学生)。
ユーザーは、自分が行った変更が既存のコードで問題ないことをどのように確認できますか?
エラーを見つけるために、プログラムを実行し、各機能を 1 つずつチェックする必要があります。
あなたはこれが不可能であることを理解しています。そのため、JUnit はワンクリックでそれを行います (バックグラウンドでも必要な場合)。
したがって、学生はコードを追加し、既存のコードがまだ機能しているかどうかを確認するためにテストを実行できます。
学生は、すべて問題がないかどうかを自動的にテストする独自のテストを作成することもできます。実際、JUnitを使用すると、コードの各部分を他の部分に依存することなくテストできます。このようにして、接続を「モック」するだけで、ネットに接続せずにインターネット接続をテストすることもできます.
この部分は長くて複雑な部分なので説明は省きます。テストと XP プログラミングについて読むように刺激するために、その「インプット」を提供しました。
そして、stackoverflow へようこそ! この回答が気に入って、その回答が質問に対する正しいと思われる場合は、左側の小さなチェックで確認できます。