JavaのAPIドキュメントの感覚を作る - ダミー

以前は文法的特徴だけでプログラミング言語（Javaを含む）を判断していました。 if文は、あなたが期待することをしますか？ループ文は使いやすいですか？メソッドは効率的に実装されますか？

今日、物事は少し異なります。 Javaには文法的な機能が豊富に用意されていますが、Javaは単なる文法規則のセットだけではありません。 Javaには、独自の機能、独自の制限、および効果的な使用のための独自の規則を持つ、4,000以上のクラスからなる巨大なライブラリである標準アプリケーションプログラミングインターフェイス（999）があります。 <！ - 1 - > 用語の検索 APIドキュメントにはさまざまな方法があります。それぞれの方法はある状況で便利です。たとえば、JavaにはSystemという名前のメソッドがあります。でる。 println。以下では、システムをルックアップする2つの方法について説明します。でる。 printlnメソッド。

索引の使用

システムなどの検索方法は次のとおりです。でる。 println、索引を使用して：

文書をご覧ください。オラクルcom / javase / 8 / docs / api /。

- >

図のように、ページの上部にある[INDEX]リンクをクリックしてインデックスを開きます。

図1：APIドキュメントのメインページ。
文字のリストは、インデックスの上部にあります（図2参照）。 Pリンクをクリックすると、printlnがあるセクションに移動します。
">

<！ - 3 - >図2：APIドキュメントのインデックスページ。
Pセクションで、printlnを検索してprintlnエントリを探します。

ほとんどのWebブラウザでは、ページのテキストでprintlnのようなものを検索できます。方法は次のとおりです：
大部分のページを占める大きなフレームで検索することをブラウザが認識していることを確認します（ページの左側の小さなフレームでは表示されません）。これを行うには、大きな枠の中でマウスをクリックします。（リンクをクリックしないで、フレームの白い部分をクリックします。）
ブラウザの[検索]ダイアログボックスを開きます。ほとんどのWindowsブラウザでCtrl + Fキーを押すと、[検索]ダイアログボックスが隠れてしまいます。 Macでは、Command + Fをクリックするとそのトリックが実行されます。

[検索]ダイアログボックスが表示されたら、テキストボックスに「println」と入力し、ボックスの[検索]または[次を検索]ボタンをクリックします。
1. printlnエントリの1つを選択します。
2. Pセクションには、図3に示すように、printlnエントリのボート負荷が大きくなります。エントリは、2つの点で互いに異なります。
3. 各エントリはprintln（int）、println（String）、またはprintln（someOtherTypeName）です。タイプ名は、エントリーごとに異なる場合があります。
各エントリは、printlnがjavaクラスのメソッドであることを示します。

someStuff someMoreStuff
- クラスはエントリーごとに異なる場合があります。
- APIドキュメントのインデックスのprintlnエントリ。 "> 図3：APIドキュメントのインデックスにあるprintlnエントリ。この時点で、それは周りを突くことを支払う。あなたが "Hello world！"のようなものを印刷しようとしているなら！ "、println（String）のいずれかのエントリが必要です。一方、lengthOfStraightLineの値を印刷しようとしている場合は、おそらくprintln（double）の項目を選択します。
  
  println（String）を決めたとします。 3つのprintln（String）エントリから選択できます。 1つはクラスjavaのメソッドだと言います。 io。 PrintStream、次はjavaクラスのメソッドです。 io。 PrintWriter、そして3番目はJavaクラスのメソッドです。 SQL。 DriverManager。これらの3つのエントリのどれを選択しますか？
  あなたが本当に呼びたいのは、システムという名前です。でる。 println。 Systemoutを使ってルックアップ全体を調べると、そのシステムが見つかります。出力にはPrintStream型があります。（下の図4を参照してください）したがって、選択するprintln（String）項目は
println（String） - クラスjavaのメソッドです。 io。 PrintStream。

out変数にはPrintStream型があります。 ">

図4：out変数にはPrintStream型があります。

選択したエントリのリンクをクリックします。

println（String）リンクをクリックすると、ブラウザは図5に示すようにprintlnメソッドを説明するページに移動します。このページにはprintlnの動作が示されます（ "Print an String then …"）。他の便利なページを指しています。たとえば、Stringのドキュメントがあるページのようです。
printlnメソッド。図5：printlnメソッドの説明。
クラスのリストの使用

クラスのリストから開始することで、APIのエントリを見つける方法は次のとおりです。

ドキュメントを参照してください。オラクルcom / javase / 8 / docs / api /。
<！ - 1 - >

Systemクラスを記述するページを探します。

システムについて説明しているドキュメントを探しています。でる。 println。だから、あなたはシステムを見て、自分のやり方で働いて、そこからprintlnへ行く。

システムへのリンクを見つけるには、ページの左側の下のフレームを見ます。ページ上でテキストを見つけるヒントについては、「インデックスの使用」セクションのステップ3を参照してください。
<！ - 2 - >
システムクラス。 ">

図6：Systemクラスへのリンクの検索

システムリンクをクリックすると、図7に示すように、ブラウザにSystemクラスのドキュメントページが表示されます。
システムクラスのドキュメント。 ">
<！ - 3 - >図7：Systemクラスのドキュメント。
Systemクラスのドキュメントページで、out変数を見つけます。
Webブラウザの[検索]ダイアログボックスを使用する場合は、[次を検索]ボタンを何度かクリックする必要があります。（名前は非常に一般的なので、System documentationページのいくつかの異なる文脈で数回現れます）。探しているものが見つかったら、上の図4に示すような表が表示されます。

テーブルの行の中で、PrintStreamリンクをクリックします。
ドキュメントによれば、out変数はPrintStream型のオブジェクトを参照します。つまり、printlnはPrintStreamクラスの一部です。そのため、あなたはPrintStreamリンクをクリックしています。
PrintStreamのドキュメントページで、println（String）を見つけます。

上記の図5に示すような説明が表示されます。
あなたもそれをやることができます。

この記事の手順を実行した後、「大したこと！私はAPIのドキュメントでprintlnを見つけることができますが、おそらく他のものを見つけることはできません。また、自分でプログラムするもののドキュメントを作成した場合、そのドキュメントは標準のAPIドキュメントのようには見えません。私はクリークの上にいます。 "
そのような異論への適切な対応は、「ナンセンス！バロニー！たわごと！ホースの羽根！ "理由は次のとおりです。

標準のJavaドキュメントで必要なものを見つけるために必要な技のほとんどが、この記事の段階的な説明に示されています。あなたがシステムを見つけることができれば。でる。 println、あなたも見つけることができます。スイング。 JButton、または標準Java APIの4,200のプログラムのいずれかを使用します。

また、Javaとクラス、メソッド、変数間の関係について詳しく知ると、この記事の段階的な説明はより自然に感じられます。

他の人の文書を読むことに関しては、あなたのリストからすぐにその問題をスクラッチすることができます。標準のAPIドキュメントは手作業では書かれていませんでした。それらは実際のJavaプログラムコードから自動的に生成されました。たとえば、PrintStreamのコードです。 javaは次のようないくつかの行を持っています：

/ ** *文字列を出力してから行を終了します。 *このメソッドは、*

{@ link #print（String）}

*を呼び出し、次に

{@ link#println（）}

を呼び出すかのように動作します。 * * @param x印刷される

String

。 * /

APIドキュメントを作成するには、Javaのキャプテンが

javadoc

というプログラムを実行しました。 javadocプログラムは、PrintStreamからこれらの行を正しく取り出しました。 javaファイルを作成し、その行を使用してWebブラウザに表示されるドキュメントを作成します。

他のJavaプログラマも同じことをしています。実際、Javaコードを書く人はすべて、javadocプログラムを使ってドキュメントを生成します。だから皆のJavaのドキュメントは他の人のJavaのドキュメントのように見える。標準のAPIドキュメントをどのように読んでいるかを知っているなら、誰も自ら作成したJavaドキュメントを読む方法を知っています。

そして、はい、javadocプログラムを使用して独自のドキュメントを作成できます。 JDKをダウンロードすると、契約の一部としてjavadocプログラムが取得されます。