Making Sense Dokumentation der Java API
Es war einmal eine Zeit, die Menschen beurteilt Programmiersprachen (einschließlich Java) allein durch ihre grammatische Funktionen. Hat ein ob
Aussage tun, was Sie erwarten, dass es zu tun? Sind Schleifenanweisungen leicht zu bedienen? Sind implementierten Methoden effizient?Heute sind die Dinge ein wenig anders. Java hat eine ganze Sammlung von grammatische Funktionen, aber Java ist viel mehr als nur eine große Menge von Grammatikregeln. Java hat einen Standard Application Programming Interface -eine riesige Bibliothek von über 4.000 Klassen aus, die jeweils ihre eigene Funktionalität, seine eigenen Grenzen, und seine eigenen Regeln für die effektive Nutzung.
Die Suche nach einem Begriff
Sie können Dinge in der API-Dokumentation in einer Reihe von verschiedenen Möglichkeiten finden. Jeder Weg ist in einer Situation oder einem anderen bequem. Zum Beispiel hat eine Methode namens Java System.out.println. Was folgt, beschreibt zwei Möglichkeiten, die zu sehen System.out.println Verfahren.
Mit dem Index
Hier ist, wie etwas zu finden, wie zum Beispiel System.out.println, durch den Index unter Verwendung von:
Klicken Sie auf die INDEX-Link am oberen Rand der Seite, um den Index zu öffnen, wie in Abbildung 1 gezeigt.
Abbildung 1: Die Hauptseite der API-Dokumentation.Eine Liste der Buchstaben ist in der Nähe der Spitze des Index (siehe Abbildung 2). Klicken Sie auf die P-Link zu dem Abschnitt zu gehen mit println drin.
"/>Abbildung 2: Die Index-Seite der API-Dokumentation.Im P Abschnitt, eine Suche nach println zu finden die println Einträge.
Die meisten Web-Browser ermöglicht es Ihnen, nach etwas zu suchen, wie println im Text einer Seite. Hier ist wie:
Stellen Sie sicher, dass der Browser weiß, dass man in den großen Rahmen zu suchen, die den größten Teil der Seite (und nicht in den kleineren Rahmen auf der linken Seite auf der Seite) in Anspruch nimmt. Um dies zu tun, klicken Sie auf Ihre Maus in den großen Rahmen. (Klicken Sie nicht auf einen Link. Klicken Sie auf einem neutralen weißen Bereich des Rahmens.)
Öffnen Sie das Dialogfeld des Browsers ein. Auf den meisten Windows-Browser, durch Drücken von Strg + F entlockt Sie das Dialogfeld aus ihrem Versteck. Auf einem Mac Befehl + F Klick funktioniert der Trick.
Wenn Sie das Dialogfeld Suchen anzuzeigen, geben Sie println in das Textfeld und die Suche die Box klicken oder Schaltfläche Weitersuchen.
Wählen Sie eine der println Einträge.
Der P-Abschnitt hat eine große Schiffsladung println Einträge, wie unten in 3 gezeigt. Die Einträge unterscheiden sich voneinander in zwei Arten:
Jeder Eintrag sagt println (int), println (String), oder println (someOtherTypeName). Der Typname kann von einem Eintrag zum anderen unterscheiden.
Jeder Eintrag besagt, dass println ist eine Methode in der Klasse Java.someStuff.someMoreStuff. Die Klasse kann von einem Eintrag zum anderen unterscheiden.
println Einträge in den Index der API-Dokumentation. "/>An dieser Stelle lohnt es sich herum zu stochern. Wenn Sie versuchen, so etwas wie zu drucken "Hallo Welt!", Sie wollen eine der println (String) Einträge. Auf der anderen Seite, wenn Sie versuchen, den Wert zu drucken lengthOfStraightLine, Sie wählen wahrscheinlich ein println (double) Eintrag.
Angenommen nun, Sie haben beschlossen, auf println (String). Sie können aus drei wählen println (String) Einträge. Man sagt, es ist eine Methode in der Klasse java.io.PrintStream, die nächste ist eine Methode in der Klasse java.io.PrintWriter,und die dritte ist eine Methode in der Klasse java.sql.DriverManager. Welche dieser drei Einträge wählen Sie?
Nun, was Sie wirklich zu nennen versucht ist etwas named System.out.println. Wenn Sie die ganze Lookup rigmarole durch mit SystemOut, Sie werden feststellen, dass System.out hat Typ Print. (Siehe Abbildung 4, unten). So ist die println (String) Eintrag, den Sie wählen, entscheiden,
println (String) - Methode in der Klasse java.io.PrintStream.
out Variable Typ Print."/>Klicken Sie auf den Link für den Eintrag, den Sie gewählt haben.
Wenn Sie die println (String) Link klicken, nimmt der Browser, den Sie zu einer Seite, die eine erklärt println Verfahren, sagt Ihnen, wie in Abbildung 5 Die Seite gezeigt, was println ist ( "ein String drucken und dann....") und verweist auf andere nützliche Seiten, wie die Seite mit der Dokumentation Schnur.
println Methode. "/>Mit Hilfe der Liste der Klassen
Hier ist, wie ein Eintrag in der API zu finden, indem in der Liste der Klassen starten:
Hier finden Sie die Seite, die die Dokumente System Klasse.
Sie suchen nach Dokumentation, die erklärt, System.out.println. Also Sie sehen System, arbeiten Sie Ihren Weg zu aus, und von dort aus, arbeiten Sie sich an println.
Für einen Link zu System, Blick in den unteren Rahmen auf der linken Seite der Seite. (Siehe Abbildung 6.) Für Hinweise auf den Text zu finden, auf der Seite finden Sie in Schritt 3 in der "Verwendung des Index" Abschnitt.
System-Klasse. "/>Abbildung 6: Die Suche nach einer Verbindung zu der System Klasse.das System-Link klicken, macht Ihren Browser für die in der Dokumentation Seite anzeigen System class, wie in 7 gezeigt.
System-Klasse in der Dokumentation. "/>Abbildung 7: Die System Klasse in der Dokumentation.Auf der Dokumentationsseite für die System Klasse, finden die aus Variable.
Wenn Sie Ihren Web-Browser des Dialogfeld Suchen verwenden, müssen Sie auf die Schaltfläche Weiter mehrere Male suchen klicken. (Der Name aus so üblich ist, scheint es, mehrmals in verschiedenen Zusammenhängen auf die System Dokumentation Seite.) Wenn Sie gefunden haben, was Sie suchen, finden Sie eine Tabelle wie die in Abbildung 4 dargestellt, siehe oben.
In der Tabelle ist aus Zeile, klicken Sie auf den Link Print.
Gemäß der Dokumentation, die aus Variable bezieht sich auf ein Objekt vom Typ Print. Das bedeutet, dass println ist Teil der Print Klasse. Das ist, warum Sie Sie auf den Button Print Link.
Auf der Dokumentationsseite für Print, finden println (String).
Sie sehen eine Erklärung, wie die in 5 gezeigt ist, oben.
Sie können es auch tun
Nachdem Sie die Schritte in diesem Artikel, werden Sie versucht zu sagen: "Big Deal! Ich finden kann, println in der API-Dokumentation, aber ich kann wohl nichts anderes finden. Und wenn die Leute Dokumentation für Sachen erstellen, die sie auf ihr eigenes Programm, dann ist ihre Dokumentation wird nicht wie die Standard-API-Dokumentation. Ich werde auf einem Bach sein. "
Die angemessene Reaktion auf eine solche Einwand ist "Unsinn! Quatsch! Balderdash! Pferde Federn!" Hier ist der Grund:
Die meisten der Tricks, die Sie brauchen für die Dinge in der Standard-Java-Dokumentation zu finden, werden in diesem Artikel Schritt-für-Schritt-Anleitungen erläutert. Wenn Sie finden System.out.println, finden Sie auch javax.swing.JButton oder einen der 4.200-Programme in der Standard-Java-API.
Und, wie Sie mehr über Java und die Beziehungen zwischen den Klassen zu entdecken, Methoden und Variablen in diesem Artikel Schritt-für-Schritt-Anleitung wird viel natürlicher fühlen.
Wie für andere Menschen in der Dokumentation zu lesen, können Sie dieses Problem direkt aus Ihrer Liste kratzen. Die Standard-API-Dokumentation wurden nicht von Hand eingegeben haben. Sie wurden automatisch von den tatsächlichen Java Programmcode generiert. Zum Beispiel kann der Code für PrintStream.java hat ein paar Zeilen, die wie folgt aussehen:
/ *** Einen String drucken und dann die Linie zu beenden. * Diese Methode verhält sich, als ob sie aufruft *
{@link #print (String)}*und dann{@link #println ()}.** @ Param x DerSchnurgedruckt werden. * /Um die API-Dokumentation zu erstellen, liefen die Kapitäne von Java ein Programm namens javadoc. Das javadoc Programm nahm Linien wie diese direkt aus dem PrintStream.java Datei und verwendet, um die Zeilen in der Dokumentation zu machen, die Sie in Ihrem Web-Browser zu sehen.
Andere Java-Programmierer tun das Gleiche. In der Tat, jeder, der Java-Code schreibt verwendet das javadoc Programm Dokumentation generieren. So kann jeder Java-Dokumentation sieht aus wie Java alle anderen Dokumentation. Wenn Sie wissen, wie man die Standard-API-Dokumentation zu lesen, wissen Sie, wie jemand das homegrown Java-Dokumentation zu lesen.
Und ja, können Sie das javadoc-Programm verwenden, um Ihre eigene Dokumentation zu erstellen. Wenn Sie das JDK herunterladen, erhalten Sie das javadoc-Programm als Teil des Deals.