Einmal die API-Dokumentation von Java - Dummies

Es wurde einmal eine Programmiersprache (einschließlich Java) nur anhand ihrer grammatikalischen Merkmale beurteilt. Führt eine if-Anweisung das aus, was Sie von ihr erwarten? Sind Schleifenanweisungen einfach zu verwenden? Werden Methoden effizient umgesetzt?

Heutzutage sind die Dinge ein bisschen anders. Java hat eine ganze Sammlung grammatikalischer Merkmale, aber Java ist viel mehr als nur ein großer Satz von Grammatikregeln. Java hat eine Standard Appl Programmierschnittstelle - eine riesige Bibliothek, die aus über 4.000 Klassen besteht, jede mit ihrer eigenen Funktionalität, eigenen Einschränkungen und eigenen Regeln für die effektive Nutzung.

Suche nach einem Begriff

Sie können die Dinge in der API-Dokumentation auf verschiedene Arten finden. Jeder Weg ist in der einen oder anderen Situation bequem. Zum Beispiel hat Java eine Methode namens System. aus. Druckln. Im Folgenden werden zwei Möglichkeiten zum Nachschlagen des Systems beschrieben. aus. Druckmethode.

Verwenden des Indexes

So finden Sie etwas wie System. aus. println mit dem Index:

Dokumente aufrufen. Orakel. com / javase / 8 / docs / api /.
Klicken Sie oben auf der Seite auf den Link INDEX, um den Index zu öffnen (siehe Abbildung 1).

Abbildung 1: Die Hauptseite der API-Dokumentation.
Eine Liste mit Buchstaben befindet sich am oberen Ende des Index (siehe Abbildung 2). Klicken Sie auf den P-Link, um zum Abschnitt mit der Println-Datei zu gelangen.

">
Abbildung 2: Die Indexseite der API-Dokumentation.
Führen Sie im Abschnitt P eine Suche nach println durch, um die println-Einträge zu finden.

Die meisten Webbrowser ermöglichen es Ihnen, nach etwas wie println im Text einer Seite zu suchen. So geht's:
1. Vergewissern Sie sich, dass der Browser weiß, dass Sie in dem großen Rahmen suchen möchten, der den größten Teil der Seite belegt (und nicht in den kleineren Rahmen auf der linken Seite). Klicken Sie dazu mit der Maus in den großen Rahmen. (Klicken Sie nicht auf einen Link. Klicken Sie auf einen neutralen weißen Bereich des Rahmens.)
2. Öffnen Sie das Dialogfeld Suchen des Browsers. Wenn Sie bei den meisten Windows-Browsern Strg + F drücken, wird das Dialogfeld "Suchen" ausgeblendet. Auf einem Mac funktioniert das Klicken von Command + F.
3. Wenn Sie das Dialogfeld "Suchen" sehen, geben Sie "println" in das Textfeld ein und klicken Sie auf die Schaltfläche "Suchen" oder "Weitersuchen".
Wählen Sie einen der println-Einträge aus.

Der P-Abschnitt hat eine große Bootsladung von Druckeinträgen, wie in Abbildung 3 unten gezeigt. Die Einträge unterscheiden sich auf zwei Arten voneinander:
- Jeder Eintrag enthält println (int), println (String) oder println (someOtherTypeName). Der Typname kann sich von einem Eintrag zum anderen unterscheiden.
- Jeder Eintrag sagt aus, dass println eine Methode in der Klasse java ist. EinigeStoffe. etwasMoreStuff . Die Klasse kann sich von einem Eintrag zum anderen unterscheiden.
  
  println-Einträge im Index der API-Dokumentation. ">
  Abbildung 3: Einige println-Einträge im Index der API-Dokumentation.
An diesem Punkt zahlt es sich aus, herumzustochern. Wenn Sie versuchen, etwas wie "Hallo Welt! ", Sie wollen einen der println (String) -Einträge. Wenn Sie versuchen, den Wert von lengthOfStraightLine zu drucken, wählen Sie wahrscheinlich einen println (double) -Eintrag aus.

Nehmen wir an, Sie haben sich für println (String) entschieden. Sie können zwischen drei println (String) -Einträgen wählen. Man sagt, es ist eine Methode in der Klasse Java. io. PrintStream, der nächste ist eine Methode in der Klasse Java. io. PrintWriter und der dritte ist eine Methode in der Klasse Java. Sql. TreiberManager. Welche dieser drei Einträge wählst du?

Nun, was Sie wirklich versuchen zu nennen, ist etwas namens System. aus. Druckln. Wenn Sie mit Systemout das gesamte Lookup-Rigmarole durchgehen, finden Sie dieses System. out hat den Typ PrintStream. (Siehe Abbildung 4, unten.) Der Eintrag println (String), den Sie auswählen, lautet

println (String) - Methode in der Klasse java. io. DruckStream. Die Variable

out hat den Typ PrintStream. ">
Abbildung 4: Die out-Variable hat den Typ PrintStream.
Klicken Sie auf den Link für den ausgewählten Eintrag.

Wenn Sie auf den Link println (String) klicken, gelangen Sie zu einer Seite, die eine println-Methode erklärt (siehe Abbildung 5). Auf der Seite erfahren Sie, was println tut ("Eine Zeichenfolge drucken und dann …"). verweist auf andere nützliche Seiten, wie die Seite mit der Dokumentation für String.

Druckmethode. ">
Abbildung 5: Eine Beschreibung der Druckmethode.

Verwenden der Liste der Klassen

So finden Sie einen Eintrag in der API, indem Sie in der Liste der Klassen beginnen:

Dokumente aufrufen. Orakel. com / javase / 8 / docs / api /.
Suchen Sie die Seite, die die Systemklasse dokumentiert.

Sie suchen nach einer Dokumentation, die System erklärt. aus. Druckln. Sie suchen also nach System, arbeiten sich nach außen und arbeiten von dort aus Ihren Weg zum Druck.

Um einen Link zu System zu finden, schauen Sie in den unteren Frame auf der linken Seite der Seite. (Siehe Abbildung 6.) Hinweise zum Suchen von Text auf der Seite finden Sie unter Schritt 3 im Abschnitt "Verwenden des Index".

Systemklasse. ">
Abbildung 6: Finden einer Verbindung zur Systemklasse.
Wenn Sie auf den Link System klicken, zeigt Ihr Browser die Dokumentationsseite für die Systemklasse an, wie in Abbildung 7 gezeigt.

Dokumentation der Systemklasse. ">
Abbildung 7: Die Dokumentation der Systemklasse.
Suchen Sie auf der Dokumentationsseite der Systemklasse die out-Variable.

Wenn Sie das Suchen-Dialogfeld Ihres Webbrowsers verwenden, müssen Sie mehrmals auf die Schaltfläche Weitersuchen klicken. (Der Name out ist so verbreitet, dass er mehrmals in verschiedenen Kontexten auf der Systemdokumentationsseite angezeigt wird.) Wenn Sie gefunden haben, wonach Sie suchen, sehen Sie eine Tabelle wie die in Abbildung 4 oben gezeigte.
Klicken Sie in der Tabellenzeile auf die PrintStream-Verknüpfung.

Die Variable out bezieht sich laut Dokumentation auf ein Objekt vom Typ PrintStream.Dies bedeutet, dass println Teil der PrintStream-Klasse ist. Deshalb klicken Sie auf den Link PrintStream.
Auf der Dokumentationsseite für PrintStream finden Sie println (String).

Sie sehen eine Erklärung wie die in Abbildung 5 gezeigte.

Sie können es auch tun

Nachdem Sie die Schritte in diesem Artikel befolgt haben, könnten Sie versucht sein zu sagen: "Big Deal! Ich kann println in den API-Dokumenten finden, aber ich kann wahrscheinlich nichts anderes finden. Und wenn Leute Dokumentationen für Dinge erstellen, die sie selbst programmieren, dann wird ihre Dokumentation nicht wie die Standard-API-Dokumentation aussehen. Ich werde auf einem Bach sein. "

Die angemessene Antwort auf einen solchen Einwand ist" Unsinn! Quatsch! Mumpitz! Pferdenfedern! "Hier ist der Grund:

Die meisten Tricks, die Sie benötigen, um Dinge in der Standard-Java-Dokumentation zu finden, werden in den schrittweisen Anleitungen dieses Artikels veranschaulicht. Wenn Sie System finden können. aus. println finden Sie auch javax. Swing. JButton oder eines der 4, 200 Programme in der Standard-Java-API.

Wenn Sie mehr über Java und die Beziehungen zwischen Klassen, Methoden und Variablen erfahren, werden sich die schrittweisen Anleitungen dieses Artikels viel natürlicher anfühlen.
Wenn Sie die Dokumentation anderer Leute lesen, können Sie dieses Problem direkt von Ihrer Liste entfernen. Die Standard-API-Dokumente wurden nicht von Hand eingegeben. Sie wurden automatisch aus dem aktuellen Java-Programmcode generiert. Zum Beispiel der Code für PrintStream. Java hat ein paar Zeilen, die ungefähr so aussehen:
```
/ ** * Gibt einen String aus und beendet die Zeile. * Diese Methode verhält sich so, als würde sie *

{@ link #print (String)}

* und dann

{@ link #println ()}

aufrufen. * * @param x Der zu druckende

String

. * /
```
Um die API-Dokumentation zu erstellen, führten die Kapitäne von Java ein Programm namens javadoc aus. Das Javadoc-Programm hat solche Zeilen direkt aus dem PrintStream übernommen. Java-Datei und verwendet die Zeilen, um die Dokumentation zu erstellen, die Sie in Ihrem Webbrowser sehen.

Andere Java-Programmierer machen das Gleiche. In der Tat verwendet jeder, der Java-Code schreibt, das Javadoc-Programm, um eine Dokumentation zu erzeugen. So sieht jedermanns Java-Dokumentation wie jede andere Java-Dokumentation aus. Wenn Sie wissen, wie Sie in die Standard-API-Dokumentation eingelesen werden, können Sie die eigenen Java-Dokumente von anderen Benutzern lesen.

Und ja, Sie können das Javadoc-Programm verwenden, um Ihre eigene Dokumentation zu erstellen. Wenn Sie das JDK herunterladen, erhalten Sie das Javadoc-Programm als Teil des Deals.