Javadoc richtig lesen...

[Bullz]

hallo, mein Problem hat hier nicht mit dem Programmcode zu tun sondern zu verstehen wie ich anhand der Dokumentation auf folgendes gekommen wäre

Scanner s = new Scanner(System.in); // es geht genau um das System.in

Anhand der Dokumentation wäre ich nicht draufgekommen, das wenn ich einen Text eingeben will, ich das so schreiben müsste ...

Wie ging ich vor ?

scanner liest daten ein... also hier nachgucken
Scanner (Java Platform SE 7 ))
( Die Beispiele in der Dokumentation von Scanner zählen nicht. Das muss irgendwo anderes professioneller stehen. Kann mich nicht auf Beispiele verlassen )

da les ich etwas was so ungefähr passen könnte ...

Scanner(InputStream source)

Schwupp dort hin: InputStream (Java Platform SE 7 )

Dort finde ich aber gar nichts was irgendwie auf System.in hindeuten würde. An dieser Stelle würde ich nicht mehr weiterkommen...

zufälligerweise weiß ich aber wo das steht was ich brauche... hier unter System unter Field Summary steht das was ich brauche ... wie wäre ich dorthingekommen wenn ich nicht die Beispiele gesehen hätte ?
System (Java Platform SE 7 )

Ich möchte sicher sein mit dem Umgang der Dokumentation ... ist sicher gleich wichtig wie das Coden selbst.. :rtfm:

 

[Mujahiddin]

Und wer hat dir gesagt, dass es einen Scanner gibt?
Manche sachen stehen nicht in der Dokumentation. Vor allem stehen nicht alle Möglichkeiten drin. Die Dokumentation ist oft abstrakt, manchmal werden Beispiele gebracht.

System.in und Scanner sind zwei grundverschiedene Sachen. System.in ist der InputStream des Systems - ein Objekt, das von der Klasse InputStream erbt und somit kann der Scanner darum gewrappt werden. Nicht mehr und nicht weniger.

Es gibt viele Sachen, die wird man nicht einfach so finden können. Zumindest nicht beim gezielten Suchen. Für sowas gibts Suchmaschinen wie Google. Oder du nimmst dir ein Buch und liest es durch.

 

[Bullz]

danke die antwort dass das nicht so in der Dokumentation aufgeführt reicht völlig. Bin davon ausgegangen das es doch irgendwie dasteht aber ich diese Stelle nicht finden kann.

Google anschmeisen ist anscheinend auch bei dieser gut durchdachten Java Doku noch ein muss

 

[Antoras]

Ich möchte sicher sein mit dem Umgang der Dokumentation

Dokumentation ist nicht nur API. Dazu gehört, wie du selbst schon festgestellt hast, auch Bücher, Tutorials, Code-Snippets - also alles was man über Suchmaschinen finden kann.

Wenn ich mich in eine Bibliothek oder ein Framework einarbeite, dann geschieht das nicht über die API. Da stehen eher Details wie z.B. wie man einzelne Methoden richtig benutzt. Die Dokumentation des Aufbaus von Software oder die korrekte Benutzung selbiger hat dort nichts zu suchen.

Den Arbeitsablauf den du beschrieben hast, der ist so schon richtig. Am Anfang steht oft ein Buch lesen um mit der Software einigermaßen vertraut zu werden und um einen Großüberblick zu bekommen was sie alles kann, wo Grenzen sind etc. Danach/Nebenbei sollte man anfangen zu programmieren um das umzusetzen/verstehen zu können was das Buch beschreibt. Bei einem Problem kurz überlegen ob man es selbst gelöst bekommt, wenn nicht Google fragen.

Bei selber lösen kommt noch dazu, dass man über die API sich die Methoden, die die API anbietet, anguckt. Dabei muss es reichen anhand der Signatur+Rückgabewert zu entscheiden ob einen die Methode zum Ziel führen kann. Kann man das nicht entscheiden, hat derjenige, der die Methode geschrieben hat, Müll fabriziert. Dann wird entweder auf eine andere Library umgestiegen oder Bugreport gemacht. Meint man, dass einen die Methode zum Ziel führt, kann man jetzt den doc-comment dazu lesen, hat man immer noch nicht verstanden was die Methode macht -> Library ist definitiv Schrott. Ist die Methode richtig, wird sie benutzt. Ansonsten bei Beginn des Absatzes weiter machen.

Der letzte Absatz gilt natürlich nur für Libraries/Frameworks, die für Produktionszwecke entwickelt wurden. Bei experimentellen Sachen darf man das nicht so eng sehen.

In 99% aller Fälle bei denen ich selbst nicht weiterkomme benutzte ich lieber Google als anzufangen in den doc-comments zu wühlen. Google sollte einem in den ersten 3-5 Treffern eine Lösung für das Problem präsentieren können. Wenn nicht hat man das falsche gesucht und man muss die Suchbegriffe anpassen. Mit der Zeit wird man da ziemlich effizient und findet schnell was man sucht. Das Durchlesen von doc-comments ist dagegen so ineffizient, dass es sich nicht lohnt überhaupt damit anzufangen (sofern man keine Details nachlesen möchte).

Hier gilt die Schwierigkeit des Problems einschätzen zu können. Bei herkömmlichen Sachen kann Google sofort eine Lösung präsentieren. Bei anderen Sachen lohnt es sich, Google anzuweisen lieber gleich auf den entsprechenden Mailinglisten der Software zu suchen, das kann viel Zeit sparen. Wenn man da auch nichts findet, dann muss man jemanden fragen. Entweder über Mailinglisten, Foren oder StackOverflow. Hat niemand eine Antwort muss man wohl in den Sauren Apfel beißen und Source Code durchlesen, debuggen, reverse-engineering betreiben. Das dauert aber natürlich viel länger und benötigt deutlich mehr Erfahrung und Übung.

 

[troll]

es gibt dinge ... und dazu gehören nun mal die packages java.lang und java.util die einfach basis-wissen sind und so nur durch lehr-material in erfahrung gebracht werden können ...

natürlich ist es auch erfahrung die eine rolle spielt ... wenn man jahre lang mit java arbeitet weiß man in etwa wie man was suchen muss ... als anfänger ist das natürlich weit aus schwerer ...

um dir allerdings eine direkte antwort auf deine frage zu geben : in jeder doc gibt es für jede klasse ein sog. "USE" ... wo automatisch generiert für jede klasse geschrieben steht wo und wie diese innerhalb der API genutzt wird ...
nun kommt wiederum ins spiel das man wissen muss das das package java.lang die elementaren klassen von java enthält und alles gröbere was man mit dem system außerhalb der vm machen will über die klasse java.lang.System abgewickelt wird ...
sucht man also nun java.lang.System im class-use von java.io.InputStream wäre man so drauf gekommen das java.io.InputStream in der klasse java.lang.System als "standard system input" verwendet wird ...
so hätte man also auch ohne die beispiele drauf kommen können ...

allerdings ist hier natürlich die frage berechtigt : woher weist du das man java.util.Scanner dafür nutzt daten von einem InputStream zu lesen ? sicher weil es dir jemand gesagt hat / du es gelesen hast ... und genau so eignet man sich auch erstmal das basis-wissen über java an ...