How do i read java documentation? [closed]


I'm looking for some advice on how to go about reading the online documentation of various packages classes and methods for java.

i mean all this stuff: http://java.sun.com/javase/6/docs/api/


Answers:


Here's a tutorial.

And indeed, read it only when needed. For the remnant, go through a tutorial. Usually Googling "[keyword] tutorial site:oracle.com" yields enough results.

Update to take the following as an example for which you'd like to find the Javadoc:

someString.split("\\.");

Here someString is an instance of java.lang.String. Assuming that you'd like to start up from the API documentation root (I myself rather prefer to type just "java.lang.string javase api site:oracle.com" in Firefox's address bar to get it straight for me (if you feel lucky and didn't already have it in browser history), or to just check it in my IDE), then scroll in the main frame to the java.lang package and click the link, then in the class summary check the String class and click the link, then in the method summary check the split() method and click the link.

The Javadoc of the Java SE API is concise, but pretty complete and provides links to other javadocs where you expect them to be. For example, at the bottom of the String#split() javadoc you see a "See Also" link to the Pattern class, which in turn explains that regex stuff in the class' introduction.