API Documentation

[Franklin Marquette]

Head First Java tells me that I need API Documentation - I know it is on java.sun.com but what program is it - It says I need the J2SE API but there are multiple programs with that same name - so which one is the right one?

Also what is the purpose of the API Documentation and is it basically an add on to the JDK or is it a program in and of itself?

THANKS for the help!

[Campbell Ritchie]

This is where you will find the documentation (for the most recent version, Java7). It is a formal description of the >4000 classes available in the standard Java® download.
Whenever you use a method, read what the documentation says. Even if you can't understand it at present. You can look in the Java Language Specification, which is even more formal and usually even harder to understand. Or the Java Tutorials, which are usually easier to understand.

[Franklin Marquette]

Okay - but which one do I download and what is its purpose - I just dont understand where it goes once I download it - is it an add on or an independent program?

THANKS!

[Campbell Ritchie]

You usually use it as a website; there is another version you can download and unzip, but that is usually only for when you don't have an internet connection. Try here.

[Jj Taylor]

This is a bit of a newb response but I'm guessing your new to it like I'm new to the forum....

Have you tried just installing Eclipse IDE which installs on all platforms?? All you have to do then is create a project and class then it does most of the work for you when it comes to documentation and help with syntax...

CTRL + SHIFT + O for importing API / Classes? (Need to pick the right word for this..) bassically, example.. 'import java.applet.Applet;'

CTRL + SPACE for finding possible functions methods you might need in that object etc

CTRL + SHIFT + F for cleaning up code formatting

Hope this helps....

Heres the link --- http://www.eclipse.org/downloads/

[Franklin Marquette]

@Jj Taylor - I already have Netbeans IDE - Head First Java for whatever reason states that it is best to start writing programs in a simple editor such as Notepad

@Campbell Ritchie - Do I need the Java SE or the Java FX?

THANKS for all the help!!

[Bear Bibeault]

Franklin Marquette wrote:@Jj Taylor - I already have Netbeans IDE - Head First Java for whatever reason states that it is best to start writing programs in a simple editor such as Notepad

This is absolutely correct. IDEs will just obfuscate the details that you need to learn. And IDE will come later.

@Campbell Ritchie - Do I need the Java SE or the Java FX?

Java FX is for writing GUIs. You need Java SE regardless.

[Campbell Ritchie]

Actually you want the SE JDK not JRE. You can run programs with the JRE but not create new ones.
Don't use MS NotePad; look at these suggestions and these. That includes the bit about writing backwards.

[Jj Taylor]

Everyones got there own way of picking it up easier and I found using an IDE like eclipse because its easier to access the DOC for help, similar to first question I asked on this forum was to do with documentation.

Once I've picked things up a bit more easier then I'd probably challenge myself to something like notepad, not the hardest way first then easiest, I thought with learning you'd want to go down this route.

There is a point though, like back in the day you would have to do it all with a notepad for learning as there is no other option but this day and age if something makes your life easier and to learn easier why not just use that? Its not exactly a bad learning habit especially when eclipse formats it for you and everything so when you do go back to notepad you'd have a better understanding of how to format better for reading and know what the functions do.

Each to there own though, I'm starting over (nearly a year now with Java on and off) and this is just how I've learnt, I personally own Head First Java - its one of my best books. If your able to set dual output monitor I find it a lot easier learning so you could have a PDF version of a book on one screen and coding on the other. I still use an IDE with this book for referencing

Also, if you think Head First Java is easy to pick up you should definatly check out http://www.kilobolt.com/tutorials.html (Not promoting here, no affiliation)

I've got to say this is one of the best sites to understand when it comes to knowing what everything does it clear English. It is game programming but gives clear info and even has Android Development thrown in there...

[Campbell Ritchie]

The problem with learning with an IDE is that there is so much Java® to learn that you are going to overload your brain if you have to learn the IDE too. After a few months, when you are making apps with dozens of classes, it usually becomes easier to use an IDE.

[Franklin Marquette]

I downloaded both the JAVA FX and JAVE SE documentation - I extracted the files and am left with a docs folder containing many sub folders such as API and JRE - do I move the docs folder for both the JAVA FX and JAVA SE into the JAVA folder containing my JDK and NETBEANS?

Where do I put it so my JDK can use it?

THANKS again!

[Henry Wong]

Franklin Marquette wrote:I downloaded both the JAVA FX and JAVE SE documentation - I extracted the files and am left with a docs folder containing many sub folders such as API and JRE - do I move the docs folder for both the JAVA FX and JAVA SE into the JAVA folder containing my JDK and NETBEANS?

Where do I put it so my JDK can use it?

The Java Documentation is for you. You should put it where you can use it. The JDK has no problems working without any documentation.

And as others already mentioned, what is wrong with using the online version?

Henry

[Franklin Marquette]

OHHHHHH - that makes sooooo much more sense.

Head First Java stated that it would be easier to download it so I had a hard copy.

THANKS!!

[Paul Clapham]

Normally "hard copy" means printed out on paper. You won't want that for a couple of reasons: for one, there are several thousand classes, so you would use a whole lot of paper. And second, the ability to follow links from one page of the API to another page is very useful, and you can't do that with a paper copy.

But if you just meant a "local copy", that's a useful thing if you don't always have Internet access.

[Franklin Marquette]

Yes I meant local copy - sorry beginner here:)

THANKS!!